diff --git a/404.html b/404.html index 919b39387df..31f194d1333 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@ - + diff --git a/api.html b/api.html index b7e925bf4ef..5645678b738 100644 --- a/api.html +++ b/api.html @@ -13,7 +13,7 @@ - + diff --git a/api/classes/CancellationTokenSource.html b/api/classes/CancellationTokenSource.html index 5fe5e84854d..1780c22c61e 100644 --- a/api/classes/CancellationTokenSource.html +++ b/api/classes/CancellationTokenSource.html @@ -13,7 +13,7 @@ - + @@ -32,7 +32,7 @@

The cancellation token of this source.

Source​

-

packages/extension-api/src/extension-api.d.ts:833

+

packages/extension-api/src/extension-api.d.ts:833

Methods​

cancel()​

@@ -42,7 +42,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:838

+

packages/extension-api/src/extension-api.d.ts:838

dispose()​

@@ -52,6 +52,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:843

+

packages/extension-api/src/extension-api.d.ts:843

\ No newline at end of file diff --git a/api/classes/Disposable.html b/api/classes/Disposable.html index 5b64b5d3865..446b81fcc8c 100644 --- a/api/classes/Disposable.html +++ b/api/classes/Disposable.html @@ -13,7 +13,7 @@ - + @@ -33,7 +33,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:85

+

packages/extension-api/src/extension-api.d.ts:85

new Disposable()​

new Disposable(callOnDispose): Disposable

@@ -46,7 +46,7 @@ on dispose.

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:92

+

packages/extension-api/src/extension-api.d.ts:92

Methods​

dispose()​

@@ -56,7 +56,7 @@ on dispose.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:97

+

packages/extension-api/src/extension-api.d.ts:97

create()​

@@ -67,7 +67,7 @@ on dispose.

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:99

+

packages/extension-api/src/extension-api.d.ts:99

from()​

@@ -84,6 +84,6 @@ instances of Disposable.

Returns a new disposable which, upon dispose, will dispose all provided disposables.

Source​

-

packages/extension-api/src/extension-api.d.ts:111

+

packages/extension-api/src/extension-api.d.ts:111

\ No newline at end of file diff --git a/api/classes/EventEmitter.html b/api/classes/EventEmitter.html index 646720a4e23..a18381468a4 100644 --- a/api/classes/EventEmitter.html +++ b/api/classes/EventEmitter.html @@ -13,7 +13,7 @@ - + @@ -38,7 +38,7 @@ extensions.

For the public to allow to subscribe to events from this Emitter

Source​

-

packages/extension-api/src/extension-api.d.ts:139

+

packages/extension-api/src/extension-api.d.ts:139

Methods​

dispose()​

@@ -48,7 +48,7 @@ extensions.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:148

+

packages/extension-api/src/extension-api.d.ts:148

fire()​

@@ -60,6 +60,6 @@ extensions.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:144

+

packages/extension-api/src/extension-api.d.ts:144

\ No newline at end of file diff --git a/api/classes/TelemetryTrustedValue.html b/api/classes/TelemetryTrustedValue.html index f16d49ed3eb..061b579f286 100644 --- a/api/classes/TelemetryTrustedValue.html +++ b/api/classes/TelemetryTrustedValue.html @@ -13,7 +13,7 @@ - + @@ -32,13 +32,13 @@ This is to be used when you can guarantee no identifiable information is contain

Returns​

TelemetryTrustedValue<T>

Source​

-

packages/extension-api/src/extension-api.d.ts:3879

+

packages/extension-api/src/extension-api.d.ts:3879

Properties​

value​

readonly value: T

Source​

-

packages/extension-api/src/extension-api.d.ts:3877

+

packages/extension-api/src/extension-api.d.ts:3877

\ No newline at end of file diff --git a/api/classes/Uri.html b/api/classes/Uri.html index c5c6001bf94..0a6746206be 100644 --- a/api/classes/Uri.html +++ b/api/classes/Uri.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1331

+

packages/extension-api/src/extension-api.d.ts:1331

Properties​

authority​

@@ -43,7 +43,7 @@

Authority is the www.example.com part of http://www.example.com/some/path?query#fragment. The part between the first double slashes and the next slash.

Source​

-

packages/extension-api/src/extension-api.d.ts:1343

+

packages/extension-api/src/extension-api.d.ts:1343

fragment​

@@ -51,7 +51,7 @@ The part between the first double slashes and the next slash.

Fragment is the fragment part of http://www.example.com/some/path?query#fragment.

Source​

-

packages/extension-api/src/extension-api.d.ts:1363

+

packages/extension-api/src/extension-api.d.ts:1363

fsPath​

@@ -59,7 +59,7 @@ The part between the first double slashes and the next slash.

The string representing the corresponding file system path of this Uri.

Source​

-

packages/extension-api/src/extension-api.d.ts:1353

+

packages/extension-api/src/extension-api.d.ts:1353

path​

@@ -67,7 +67,7 @@ The part between the first double slashes and the next slash.

Path is the /some/path part of http://www.example.com/some/path?query#fragment.

Source​

-

packages/extension-api/src/extension-api.d.ts:1348

+

packages/extension-api/src/extension-api.d.ts:1348

query​

@@ -75,7 +75,7 @@ The part between the first double slashes and the next slash.

Query is the query part of http://www.example.com/some/path?query#fragment.

Source​

-

packages/extension-api/src/extension-api.d.ts:1358

+

packages/extension-api/src/extension-api.d.ts:1358

scheme​

@@ -84,7 +84,7 @@ The part between the first double slashes and the next slash.

Scheme is the http part of http://www.example.com/some/path?query#fragment. The part before the first colon.

Source​

-

packages/extension-api/src/extension-api.d.ts:1337

+

packages/extension-api/src/extension-api.d.ts:1337

Methods​

toString()​

@@ -93,7 +93,7 @@ The part before the first colon.

Returns​

string

Source​

-

packages/extension-api/src/extension-api.d.ts:1402

+

packages/extension-api/src/extension-api.d.ts:1402

with()​

@@ -120,7 +120,7 @@ the empty string.

A new Uri that reflects the given change. Will return this Uri if the change is not changing anything.

Source​

-

packages/extension-api/src/extension-api.d.ts:1379

+

packages/extension-api/src/extension-api.d.ts:1379

file()​

@@ -133,7 +133,7 @@ will be file.

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1316

+

packages/extension-api/src/extension-api.d.ts:1316

joinPath()​

@@ -150,7 +150,7 @@ the path of the base uri with the provided path segments.

Uri

A new uri which path is joined with the given fragments

Source​

-

packages/extension-api/src/extension-api.d.ts:1326

+

packages/extension-api/src/extension-api.d.ts:1326

parse()​

@@ -172,6 +172,6 @@ as all uris should have a scheme. To avoid breakage of existing code the optiona

See​

Uri.toString

Source​

-

packages/extension-api/src/extension-api.d.ts:1310

+

packages/extension-api/src/extension-api.d.ts:1310

\ No newline at end of file diff --git a/api/enumerations/InputBoxValidationSeverity.html b/api/enumerations/InputBoxValidationSeverity.html index a80333c4129..6b0cc4c5893 100644 --- a/api/enumerations/InputBoxValidationSeverity.html +++ b/api/enumerations/InputBoxValidationSeverity.html @@ -13,7 +13,7 @@ - + @@ -25,20 +25,20 @@

Error: 3

Source​

-

packages/extension-api/src/extension-api.d.ts:852

+

packages/extension-api/src/extension-api.d.ts:852

Info​

Info: 1

Source​

-

packages/extension-api/src/extension-api.d.ts:850

+

packages/extension-api/src/extension-api.d.ts:850

Warning​

Warning: 2

Source​

-

packages/extension-api/src/extension-api.d.ts:851

+

packages/extension-api/src/extension-api.d.ts:851

\ No newline at end of file diff --git a/api/enumerations/ProgressLocation.html b/api/enumerations/ProgressLocation.html index fb41a771998..f2545f7123e 100644 --- a/api/enumerations/ProgressLocation.html +++ b/api/enumerations/ProgressLocation.html @@ -13,7 +13,7 @@ - + @@ -32,7 +32,7 @@ removed in future versions of Podman Desktop. We strongly encourage to use TASK_

See​

TASK_WIDGET

Source​

-

packages/extension-api/src/extension-api.d.ts:780

+

packages/extension-api/src/extension-api.d.ts:780

TASK_WIDGET​

@@ -40,6 +40,6 @@ removed in future versions of Podman Desktop. We strongly encourage to use TASK_

Show progress in the task manager widget

Source​

-

packages/extension-api/src/extension-api.d.ts:785

+

packages/extension-api/src/extension-api.d.ts:785

\ No newline at end of file diff --git a/api/enumerations/QuickPickItemKind.html b/api/enumerations/QuickPickItemKind.html index dcc50dfcf5f..0de80f58861 100644 --- a/api/enumerations/QuickPickItemKind.html +++ b/api/enumerations/QuickPickItemKind.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The default QuickPickItem.kind is an item that can be selected in the quick pick.

Source​

-

packages/extension-api/src/extension-api.d.ts:955

+

packages/extension-api/src/extension-api.d.ts:955

Separator​

@@ -35,6 +35,6 @@

When a QuickPickItem has a kind of Separator, the item is just a visual separator and does not represent a real item. The only property that applies is label . All other properties on QuickPickItem will be ignored and have no effect.

Source​

-

packages/extension-api/src/extension-api.d.ts:951

+

packages/extension-api/src/extension-api.d.ts:951

\ No newline at end of file diff --git a/api/interfaces/AuditRecord.html b/api/interfaces/AuditRecord.html index 27007438aa2..b2f46c60bea 100644 --- a/api/interfaces/AuditRecord.html +++ b/api/interfaces/AuditRecord.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

record: string

Source​

-

packages/extension-api/src/extension-api.d.ts:371

+

packages/extension-api/src/extension-api.d.ts:371

type​

type: "error" | "info" | "warning"

Source​

-

packages/extension-api/src/extension-api.d.ts:370

+

packages/extension-api/src/extension-api.d.ts:370

\ No newline at end of file diff --git a/api/interfaces/AuditRequestItems.html b/api/interfaces/AuditRequestItems.html index 5966c1ea1f2..ecdf219b80d 100644 --- a/api/interfaces/AuditRequestItems.html +++ b/api/interfaces/AuditRequestItems.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/AuditResult.html b/api/interfaces/AuditResult.html index bb810f5ef19..8bd1fccafd8 100644 --- a/api/interfaces/AuditResult.html +++ b/api/interfaces/AuditResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

records: AuditRecord[]

Source​

-

packages/extension-api/src/extension-api.d.ts:375

+

packages/extension-api/src/extension-api.d.ts:375

\ No newline at end of file diff --git a/api/interfaces/Auditor.html b/api/interfaces/Auditor.html index 95732871dae..53e3a9c2ffe 100644 --- a/api/interfaces/Auditor.html +++ b/api/interfaces/Auditor.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Promise <AuditResult>

Source​

-

packages/extension-api/src/extension-api.d.ts:384

+

packages/extension-api/src/extension-api.d.ts:384

\ No newline at end of file diff --git a/api/interfaces/AuthConfig.html b/api/interfaces/AuthConfig.html index 239deb09a06..9cf9c18e7c1 100644 --- a/api/interfaces/AuthConfig.html +++ b/api/interfaces/AuthConfig.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

optional email: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2103

+

packages/extension-api/src/extension-api.d.ts:2103

password​

password: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2101

+

packages/extension-api/src/extension-api.d.ts:2101

serveraddress​

serveraddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2102

+

packages/extension-api/src/extension-api.d.ts:2102

username​

username: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2100

+

packages/extension-api/src/extension-api.d.ts:2100

\ No newline at end of file diff --git a/api/interfaces/AuthenticationGetSessionOptions.html b/api/interfaces/AuthenticationGetSessionOptions.html index aaff8a100fb..05492234674 100644 --- a/api/interfaces/AuthenticationGetSessionOptions.html +++ b/api/interfaces/AuthenticationGetSessionOptions.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@ prompted to select an account to use when g is remembered until getSession is called with this flag.

Defaults to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:3497

+

packages/extension-api/src/extension-api.d.ts:3497

createIfNone?​

@@ -44,7 +44,7 @@ allows quietly prompting the user to sign in.

will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.

Defaults to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:3486

+

packages/extension-api/src/extension-api.d.ts:3486

forceNewSession?​

@@ -57,7 +57,7 @@ where the token needs to be re minted because it has lost some authorization.

createIfNone.

This defaults to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:3510

+

packages/extension-api/src/extension-api.d.ts:3510

silent?​

@@ -69,6 +69,6 @@ If true, no indication will be shown.

Defaults to false.

Note: you cannot use this option with any other options that prompt the user like createIfNone.

Source​

-

packages/extension-api/src/extension-api.d.ts:3522

+

packages/extension-api/src/extension-api.d.ts:3522

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProvider.html b/api/interfaces/AuthenticationProvider.html index f6a2970fa63..ada3462482d 100644 --- a/api/interfaces/AuthenticationProvider.html +++ b/api/interfaces/AuthenticationProvider.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@

An event which fires when the array of sessions has changed, or data within a session has changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3593

+

packages/extension-api/src/extension-api.d.ts:3593

Methods​

createSession()​

@@ -46,7 +46,7 @@ scopes.

Promise <AuthenticationSession>

A promise that resolves to an authentication session.

Source​

-

packages/extension-api/src/extension-api.d.ts:3616

+

packages/extension-api/src/extension-api.d.ts:3616

getSessions()​

@@ -61,7 +61,7 @@ these permissions, otherwise all sessions should be returned.

Promise<readonly AuthenticationSession[]>

A promise that resolves to an array of authentication sessions.

Source​

-

packages/extension-api/src/extension-api.d.ts:3601

+

packages/extension-api/src/extension-api.d.ts:3601

removeSession()​

@@ -76,6 +76,6 @@ these permissions, otherwise all sessions should be returned.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3626

+

packages/extension-api/src/extension-api.d.ts:3626

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html index 6086804de98..a6dc801722b 100644 --- a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html +++ b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The AuthenticationSessions of the AuthenticationProvider that have been added.

Source​

-

packages/extension-api/src/extension-api.d.ts:3570

+

packages/extension-api/src/extension-api.d.ts:3570

changed?​

@@ -36,7 +36,7 @@ A session changes when its data excluding the id are updated. An example of this is a session refresh that results in a new access token being set for the session.

Source​

-

packages/extension-api/src/extension-api.d.ts:3582

+

packages/extension-api/src/extension-api.d.ts:3582

removed?​

@@ -44,6 +44,6 @@ access token being set for the session.

The AuthenticationSessions of the AuthenticationProvider that have been removed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3575

+

packages/extension-api/src/extension-api.d.ts:3575

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderInformation.html b/api/interfaces/AuthenticationProviderInformation.html index 07eb244e124..b3ca2d38798 100644 --- a/api/interfaces/AuthenticationProviderInformation.html +++ b/api/interfaces/AuthenticationProviderInformation.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The unique identifier of the authentication provider.

Source​

-

packages/extension-api/src/extension-api.d.ts:3532

+

packages/extension-api/src/extension-api.d.ts:3532

label​

@@ -34,6 +34,6 @@

The human-readable name of the authentication provider.

Source​

-

packages/extension-api/src/extension-api.d.ts:3537

+

packages/extension-api/src/extension-api.d.ts:3537

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderOptions.html b/api/interfaces/AuthenticationProviderOptions.html index bf093e54277..3391f495212 100644 --- a/api/interfaces/AuthenticationProviderOptions.html +++ b/api/interfaces/AuthenticationProviderOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

optional readonly images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:3560

+

packages/extension-api/src/extension-api.d.ts:3560

supportsMultipleAccounts?​

@@ -34,6 +34,6 @@

Whether it is possible to be signed into multiple accounts at once with this provider. If not specified, will default to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:3558

+

packages/extension-api/src/extension-api.d.ts:3558

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSession.html b/api/interfaces/AuthenticationSession.html index 4f316a6529f..04b1825305f 100644 --- a/api/interfaces/AuthenticationSession.html +++ b/api/interfaces/AuthenticationSession.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The access token.

Source​

-

packages/extension-api/src/extension-api.d.ts:3441

+

packages/extension-api/src/extension-api.d.ts:3441

account​

@@ -34,7 +34,7 @@

The account associated with the session.

Source​

-

packages/extension-api/src/extension-api.d.ts:3446

+

packages/extension-api/src/extension-api.d.ts:3446

id​

@@ -42,7 +42,7 @@

The identifier of the authentication session.

Source​

-

packages/extension-api/src/extension-api.d.ts:3436

+

packages/extension-api/src/extension-api.d.ts:3436

scopes​

@@ -51,6 +51,6 @@

The permissions granted by the session's access token. Available scopes are defined by the AuthenticationProvider.

Source​

-

packages/extension-api/src/extension-api.d.ts:3452

+

packages/extension-api/src/extension-api.d.ts:3452

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionAccountInformation.html b/api/interfaces/AuthenticationSessionAccountInformation.html index 2f6cf0c10a9..244bb0df938 100644 --- a/api/interfaces/AuthenticationSessionAccountInformation.html +++ b/api/interfaces/AuthenticationSessionAccountInformation.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The unique identifier of the account.

Source​

-

packages/extension-api/src/extension-api.d.ts:3462

+

packages/extension-api/src/extension-api.d.ts:3462

label​

@@ -34,6 +34,6 @@

The human-readable name of the account.

Source​

-

packages/extension-api/src/extension-api.d.ts:3467

+

packages/extension-api/src/extension-api.d.ts:3467

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationSessionsChangeEvent.html index e67b8294fec..99c1e6602d1 100644 --- a/api/interfaces/AuthenticationSessionsChangeEvent.html +++ b/api/interfaces/AuthenticationSessionsChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

The authenticationProvider that has had its sessions change.

Source​

-

packages/extension-api/src/extension-api.d.ts:3547

+

packages/extension-api/src/extension-api.d.ts:3547

\ No newline at end of file diff --git a/api/interfaces/BlkioStatEntry.html b/api/interfaces/BlkioStatEntry.html index 179eb40708f..42f53bcaa1a 100644 --- a/api/interfaces/BlkioStatEntry.html +++ b/api/interfaces/BlkioStatEntry.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

major: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2803

+

packages/extension-api/src/extension-api.d.ts:2803

minor​

minor: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2804

+

packages/extension-api/src/extension-api.d.ts:2804

op​

op: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2805

+

packages/extension-api/src/extension-api.d.ts:2805

value​

value: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2806

+

packages/extension-api/src/extension-api.d.ts:2806

\ No newline at end of file diff --git a/api/interfaces/BlkioStats.html b/api/interfaces/BlkioStats.html index 4545ee17b7b..b0c35a7f03b 100644 --- a/api/interfaces/BlkioStats.html +++ b/api/interfaces/BlkioStats.html @@ -13,7 +13,7 @@ - + @@ -24,55 +24,55 @@

io_merged_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2815

+

packages/extension-api/src/extension-api.d.ts:2815

io_queue_recursive​

io_queue_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2812

+

packages/extension-api/src/extension-api.d.ts:2812

io_service_bytes_recursive​

io_service_bytes_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2810

+

packages/extension-api/src/extension-api.d.ts:2810

io_service_time_recursive​

io_service_time_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2813

+

packages/extension-api/src/extension-api.d.ts:2813

io_serviced_recursive​

io_serviced_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2811

+

packages/extension-api/src/extension-api.d.ts:2811

io_time_recursive​

io_time_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2816

+

packages/extension-api/src/extension-api.d.ts:2816

io_wait_time_recursive​

io_wait_time_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2814

+

packages/extension-api/src/extension-api.d.ts:2814

sectors_recursive​

sectors_recursive: BlkioStatEntry[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2817

+

packages/extension-api/src/extension-api.d.ts:2817

\ No newline at end of file diff --git a/api/interfaces/BuildImageOptions.html b/api/interfaces/BuildImageOptions.html index 3f44d1ef988..a6f70f146c6 100644 --- a/api/interfaces/BuildImageOptions.html +++ b/api/interfaces/BuildImageOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The abort controller for running the build image operation

Source​

-

packages/extension-api/src/extension-api.d.ts:2945

+

packages/extension-api/src/extension-api.d.ts:2945

buildargs?​

@@ -39,7 +39,7 @@ parameter buildargs={"FOO":"bar"}. Note that Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3029

+

packages/extension-api/src/extension-api.d.ts:3029

cachefrom?​

@@ -47,7 +47,7 @@ parameter buildargs={"FOO":"bar"}. Note that

JSON array of images used for build cache resolution.

Source​

-

packages/extension-api/src/extension-api.d.ts:2971

+

packages/extension-api/src/extension-api.d.ts:2971

containerFile?​

@@ -55,7 +55,7 @@ parameter buildargs={"FOO":"bar"}. Note that

Specifies a Containerfile which contains instructions for building the image

Source​

-

packages/extension-api/src/extension-api.d.ts:2925

+

packages/extension-api/src/extension-api.d.ts:2925

cpuperiod?​

@@ -63,7 +63,7 @@ parameter buildargs={"FOO":"bar"}. Note that

The length of a CPU period in microseconds.

Source​

-

packages/extension-api/src/extension-api.d.ts:3015

+

packages/extension-api/src/extension-api.d.ts:3015

cpuquota?​

@@ -71,7 +71,7 @@ parameter buildargs={"FOO":"bar"}. Note that

Microseconds of CPU time that the container can get in a CPU period.

Source​

-

packages/extension-api/src/extension-api.d.ts:3020

+

packages/extension-api/src/extension-api.d.ts:3020

cpusetcpus?​

@@ -79,7 +79,7 @@ parameter buildargs={"FOO":"bar"}. Note that

CPUs in which to allow execution (e.g., 0-3, 0,1).

Source​

-

packages/extension-api/src/extension-api.d.ts:3010

+

packages/extension-api/src/extension-api.d.ts:3010

cpushares?​

@@ -87,7 +87,7 @@ parameter buildargs={"FOO":"bar"}. Note that

CPU shares (relative weight).

Source​

-

packages/extension-api/src/extension-api.d.ts:3005

+

packages/extension-api/src/extension-api.d.ts:3005

extrahosts?​

@@ -95,7 +95,7 @@ parameter buildargs={"FOO":"bar"}. Note that

Extra hosts to add to /etc/hosts

Source​

-

packages/extension-api/src/extension-api.d.ts:2950

+

packages/extension-api/src/extension-api.d.ts:2950

forcerm?​

@@ -104,7 +104,7 @@ parameter buildargs={"FOO":"bar"}. Note that Default: false

Always remove intermediate containers, even upon failure.

Source​

-

packages/extension-api/src/extension-api.d.ts:2990

+

packages/extension-api/src/extension-api.d.ts:2990

labels?​

@@ -114,7 +114,7 @@ parameter buildargs={"FOO":"bar"}. Note that Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3044

+

packages/extension-api/src/extension-api.d.ts:3044

memory?​

@@ -122,7 +122,7 @@ parameter buildargs={"FOO":"bar"}. Note that

Set memory limit for build.

Source​

-

packages/extension-api/src/extension-api.d.ts:2995

+

packages/extension-api/src/extension-api.d.ts:2995

memswap?​

@@ -130,7 +130,7 @@ parameter buildargs={"FOO":"bar"}. Note that

Total memory (memory + swap). Set as -1 to disable swap.

Source​

-

packages/extension-api/src/extension-api.d.ts:3000

+

packages/extension-api/src/extension-api.d.ts:3000

networkmode?​

@@ -140,7 +140,7 @@ parameter buildargs={"FOO":"bar"}. Note that host, none, and container:<name|id>. Any other value is taken as a custom network's name or ID to which this container should connect to.

Source​

-

packages/extension-api/src/extension-api.d.ts:3051

+

packages/extension-api/src/extension-api.d.ts:3051

nocache?​

@@ -149,7 +149,7 @@ to which this container should connect to.

Default: false

Do not use the cache when building the image.

Source​

-

packages/extension-api/src/extension-api.d.ts:3072

+

packages/extension-api/src/extension-api.d.ts:3072

outputs?​

@@ -158,7 +158,7 @@ to which this container should connect to.

Default: ""

BuildKit output configuration

Source​

-

packages/extension-api/src/extension-api.d.ts:3065

+

packages/extension-api/src/extension-api.d.ts:3065

platform?​

@@ -166,7 +166,7 @@ to which this container should connect to.

Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host

Source​

-

packages/extension-api/src/extension-api.d.ts:2935

+

packages/extension-api/src/extension-api.d.ts:2935

provider?​

@@ -174,7 +174,7 @@ to which this container should connect to.

Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)

Source​

-

packages/extension-api/src/extension-api.d.ts:2940

+

packages/extension-api/src/extension-api.d.ts:2940

pull?​

@@ -182,7 +182,7 @@ to which this container should connect to.

Attempt to pull the image even if an older image exists locally.

Source​

-

packages/extension-api/src/extension-api.d.ts:2976

+

packages/extension-api/src/extension-api.d.ts:2976

q?​

@@ -191,7 +191,7 @@ to which this container should connect to.

Default: false

Suppress verbose build output.

Source​

-

packages/extension-api/src/extension-api.d.ts:2966

+

packages/extension-api/src/extension-api.d.ts:2966

remote?​

@@ -203,7 +203,7 @@ file is downloaded by the daemon and the contents therein used as the context fo to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball.

Source​

-

packages/extension-api/src/extension-api.d.ts:2959

+

packages/extension-api/src/extension-api.d.ts:2959

rm?​

@@ -212,7 +212,7 @@ inside the tarball.

Default: true

Remove intermediate containers after a successful build.

Source​

-

packages/extension-api/src/extension-api.d.ts:2983

+

packages/extension-api/src/extension-api.d.ts:2983

shmsize?​

@@ -220,7 +220,7 @@ inside the tarball.

Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.

Source​

-

packages/extension-api/src/extension-api.d.ts:3034

+

packages/extension-api/src/extension-api.d.ts:3034

squash?​

@@ -228,7 +228,7 @@ inside the tarball.

Squash the resulting images layers into a single layer.

Source​

-

packages/extension-api/src/extension-api.d.ts:3039

+

packages/extension-api/src/extension-api.d.ts:3039

tag?​

@@ -236,7 +236,7 @@ inside the tarball.

Specifies the name which is assigned to the resulting image if the build process completes successfully

Source​

-

packages/extension-api/src/extension-api.d.ts:2930

+

packages/extension-api/src/extension-api.d.ts:2930

target?​

@@ -245,6 +245,6 @@ inside the tarball.

Default: ""

Target build stage

Source​

-

packages/extension-api/src/extension-api.d.ts:3058

+

packages/extension-api/src/extension-api.d.ts:3058

\ No newline at end of file diff --git a/api/interfaces/CPUStats.html b/api/interfaces/CPUStats.html index c13858deddd..0762cb32333 100644 --- a/api/interfaces/CPUStats.html +++ b/api/interfaces/CPUStats.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

cpu_usage: CPUUsage

Source​

-

packages/extension-api/src/extension-api.d.ts:2900

+

packages/extension-api/src/extension-api.d.ts:2900

online_cpus​

online_cpus: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2902

+

packages/extension-api/src/extension-api.d.ts:2902

system_cpu_usage​

system_cpu_usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2901

+

packages/extension-api/src/extension-api.d.ts:2901

throttling_data​

throttling_data: ThrottlingData

Source​

-

packages/extension-api/src/extension-api.d.ts:2903

+

packages/extension-api/src/extension-api.d.ts:2903

\ No newline at end of file diff --git a/api/interfaces/CPUUsage.html b/api/interfaces/CPUUsage.html index 8aa48f3d2fb..cb7f40efb5f 100644 --- a/api/interfaces/CPUUsage.html +++ b/api/interfaces/CPUUsage.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

percpu_usage: number[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2887

+

packages/extension-api/src/extension-api.d.ts:2887

total_usage​

total_usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2889

+

packages/extension-api/src/extension-api.d.ts:2889

usage_in_kernelmode​

usage_in_kernelmode: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2890

+

packages/extension-api/src/extension-api.d.ts:2890

usage_in_usermode​

usage_in_usermode: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2888

+

packages/extension-api/src/extension-api.d.ts:2888

\ No newline at end of file diff --git a/api/interfaces/CancellationToken.html b/api/interfaces/CancellationToken.html index b4d4be5cf21..4b2f7a275ff 100644 --- a/api/interfaces/CancellationToken.html +++ b/api/interfaces/CancellationToken.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ operation to request cancellation.

Is true when the token has been cancelled, false otherwise.

Source​

-

packages/extension-api/src/extension-api.d.ts:820

+

packages/extension-api/src/extension-api.d.ts:820

onCancellationRequested​

@@ -35,6 +35,6 @@ operation to request cancellation.

An Event which fires upon cancellation.

Source​

-

packages/extension-api/src/extension-api.d.ts:826

+

packages/extension-api/src/extension-api.d.ts:826

\ No newline at end of file diff --git a/api/interfaces/CheckResult.html b/api/interfaces/CheckResult.html index 73d6bd2bbe1..01266fe00d3 100644 --- a/api/interfaces/CheckResult.html +++ b/api/interfaces/CheckResult.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

optional description: string

Source​

-

packages/extension-api/src/extension-api.d.ts:401

+

packages/extension-api/src/extension-api.d.ts:401

optional docLinks: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:403

+

packages/extension-api/src/extension-api.d.ts:403

docLinksDescription?​

optional docLinksDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:402

+

packages/extension-api/src/extension-api.d.ts:402

fixCommand?​

optional fixCommand: CheckResultFixCommand

Source​

-

packages/extension-api/src/extension-api.d.ts:404

+

packages/extension-api/src/extension-api.d.ts:404

successful​

successful: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:400

+

packages/extension-api/src/extension-api.d.ts:400

\ No newline at end of file diff --git a/api/interfaces/CheckResultFixCommand.html b/api/interfaces/CheckResultFixCommand.html index 5749b9352a7..efe96e64913 100644 --- a/api/interfaces/CheckResultFixCommand.html +++ b/api/interfaces/CheckResultFixCommand.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:395

+

packages/extension-api/src/extension-api.d.ts:395

title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:396

+

packages/extension-api/src/extension-api.d.ts:396

\ No newline at end of file diff --git a/api/interfaces/CliTool.html b/api/interfaces/CliTool.html index 31d56975810..285093caf2a 100644 --- a/api/interfaces/CliTool.html +++ b/api/interfaces/CliTool.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

displayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4076

+

packages/extension-api/src/extension-api.d.ts:4076

extensionInfo​

@@ -43,49 +43,49 @@

label: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4080

+

packages/extension-api/src/extension-api.d.ts:4080

id​

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4074

+

packages/extension-api/src/extension-api.d.ts:4074

images​

images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:4079

+

packages/extension-api/src/extension-api.d.ts:4079

markdownDescription​

markdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4077

+

packages/extension-api/src/extension-api.d.ts:4077

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4075

+

packages/extension-api/src/extension-api.d.ts:4075

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Source​

-

packages/extension-api/src/extension-api.d.ts:4086

+

packages/extension-api/src/extension-api.d.ts:4086

state​

state: "registered"

Source​

-

packages/extension-api/src/extension-api.d.ts:4078

+

packages/extension-api/src/extension-api.d.ts:4078

Methods​

dispose()​

@@ -97,7 +97,7 @@

Inherited from​

Disposable . dispose

Source​

-

packages/extension-api/src/extension-api.d.ts:97

+

packages/extension-api/src/extension-api.d.ts:97

registerUpdate()​

@@ -108,7 +108,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:4089

+

packages/extension-api/src/extension-api.d.ts:4089

updateVersion()​

@@ -119,6 +119,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:4085

+

packages/extension-api/src/extension-api.d.ts:4085

\ No newline at end of file diff --git a/api/interfaces/CliToolOptions.html b/api/interfaces/CliToolOptions.html index 7bec3ad0445..fe91fdb9914 100644 --- a/api/interfaces/CliToolOptions.html +++ b/api/interfaces/CliToolOptions.html @@ -13,7 +13,7 @@ - + @@ -25,35 +25,35 @@

displayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4040

+

packages/extension-api/src/extension-api.d.ts:4040

images​

images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:4042

+

packages/extension-api/src/extension-api.d.ts:4042

markdownDescription​

markdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4041

+

packages/extension-api/src/extension-api.d.ts:4041

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4039

+

packages/extension-api/src/extension-api.d.ts:4039

path​

path: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4052

+

packages/extension-api/src/extension-api.d.ts:4052

version​

@@ -65,6 +65,6 @@ Passing in path will also help to show where the CLI tool is expected to be inst This is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory. Note: The expected value should not include 'v'.

Source​

-

packages/extension-api/src/extension-api.d.ts:4051

+

packages/extension-api/src/extension-api.d.ts:4051

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdate.html b/api/interfaces/CliToolUpdate.html index 49c5210946a..2bd6f517551 100644 --- a/api/interfaces/CliToolUpdate.html +++ b/api/interfaces/CliToolUpdate.html @@ -13,7 +13,7 @@ - + @@ -28,13 +28,13 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4068

+

packages/extension-api/src/extension-api.d.ts:4068

version​

version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4067

+

packages/extension-api/src/extension-api.d.ts:4067

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdateOptions.html b/api/interfaces/CliToolUpdateOptions.html index 30a267d53f2..488ed211484 100644 --- a/api/interfaces/CliToolUpdateOptions.html +++ b/api/interfaces/CliToolUpdateOptions.html @@ -13,7 +13,7 @@ - + @@ -25,34 +25,34 @@

optional displayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4060

+

packages/extension-api/src/extension-api.d.ts:4060

images?​

optional images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:4062

+

packages/extension-api/src/extension-api.d.ts:4062

markdownDescription?​

optional markdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4061

+

packages/extension-api/src/extension-api.d.ts:4061

path?​

optional path: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4063

+

packages/extension-api/src/extension-api.d.ts:4063

version​

version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4059

+

packages/extension-api/src/extension-api.d.ts:4059

\ No newline at end of file diff --git a/api/interfaces/Clipboard.html b/api/interfaces/Clipboard.html index cdec4971f43..f9e7854c97c 100644 --- a/api/interfaces/Clipboard.html +++ b/api/interfaces/Clipboard.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@

Promise<string>

A Promise that resolves to a string.

Source​

-

packages/extension-api/src/extension-api.d.ts:4008

+

packages/extension-api/src/extension-api.d.ts:4008

writeText()​

@@ -42,6 +42,6 @@

Promise<void>

A Promise that resolves when writing happened.

Source​

-

packages/extension-api/src/extension-api.d.ts:4014

+

packages/extension-api/src/extension-api.d.ts:4014

\ No newline at end of file diff --git a/api/interfaces/Command.html b/api/interfaces/Command.html index 191ae8a8782..7cfb7bf8e4e 100644 --- a/api/interfaces/Command.html +++ b/api/interfaces/Command.html @@ -13,7 +13,7 @@ - + @@ -28,27 +28,27 @@ function when invoked.

optional arguments: any[]

Source​

-

packages/extension-api/src/extension-api.d.ts:55

+

packages/extension-api/src/extension-api.d.ts:55

command​

command: string

Source​

-

packages/extension-api/src/extension-api.d.ts:52

+

packages/extension-api/src/extension-api.d.ts:52

title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:51

+

packages/extension-api/src/extension-api.d.ts:51

tooltip?​

optional tooltip: string

Source​

-

packages/extension-api/src/extension-api.d.ts:53

+

packages/extension-api/src/extension-api.d.ts:53

\ No newline at end of file diff --git a/api/interfaces/Configuration.html b/api/interfaces/Configuration.html index 3f1a85315e4..3e6815adfd8 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -13,7 +13,7 @@ - + @@ -36,7 +36,7 @@

undefined | T

The value section denotes or undefined.

Source​
-

packages/extension-api/src/extension-api.d.ts:709

+

packages/extension-api/src/extension-api.d.ts:709

get(section, defaultValue)​

get<T>(section, defaultValue): T

@@ -53,7 +53,7 @@

T

The value section denotes or the default.

Source​
-

packages/extension-api/src/extension-api.d.ts:718

+

packages/extension-api/src/extension-api.d.ts:718

has()​

@@ -67,7 +67,7 @@

boolean

true if the section doesn't resolve to undefined.

Source​

-

packages/extension-api/src/extension-api.d.ts:726

+

packages/extension-api/src/extension-api.d.ts:726

update()​

@@ -80,6 +80,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:732

+

packages/extension-api/src/extension-api.d.ts:732

\ No newline at end of file diff --git a/api/interfaces/ConfigurationChangeEvent.html b/api/interfaces/ConfigurationChangeEvent.html index 5cf0d40ed0f..f551db38e2f 100644 --- a/api/interfaces/ConfigurationChangeEvent.html +++ b/api/interfaces/ConfigurationChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@ If scope is provided, checks if the section has changed for resources under the

boolean

true if the given section has changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:753

+

packages/extension-api/src/extension-api.d.ts:753

\ No newline at end of file diff --git a/api/interfaces/ContainerAuthInfo.html b/api/interfaces/ContainerAuthInfo.html index 13a90fff530..a7bcd76bd5c 100644 --- a/api/interfaces/ContainerAuthInfo.html +++ b/api/interfaces/ContainerAuthInfo.html @@ -13,7 +13,7 @@ - + @@ -25,27 +25,27 @@

optional email: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2416

+

packages/extension-api/src/extension-api.d.ts:2416

password​

password: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2414

+

packages/extension-api/src/extension-api.d.ts:2414

serveraddress​

serveraddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2415

+

packages/extension-api/src/extension-api.d.ts:2415

username​

username: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2413

+

packages/extension-api/src/extension-api.d.ts:2413

\ No newline at end of file diff --git a/api/interfaces/ContainerCreateOptions.html b/api/interfaces/ContainerCreateOptions.html index 6f610d450f1..eefde81709d 100644 --- a/api/interfaces/ContainerCreateOptions.html +++ b/api/interfaces/ContainerCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Default: false

Command is already escaped (Windows only)

Source​

-

packages/extension-api/src/extension-api.d.ts:2729

+

packages/extension-api/src/extension-api.d.ts:2729

AttachStderr?​

@@ -34,7 +34,7 @@

Whether to attach to stderr (default false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2697

+

packages/extension-api/src/extension-api.d.ts:2697

AttachStdin?​

@@ -42,7 +42,7 @@

Whether to attach to stdin (default false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2687

+

packages/extension-api/src/extension-api.d.ts:2687

AttachStdout?​

@@ -50,7 +50,7 @@

Whether to attach to stdout(default false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2692

+

packages/extension-api/src/extension-api.d.ts:2692

Cmd?​

@@ -58,7 +58,7 @@

Command to run specified as an array of strings

Source​

-

packages/extension-api/src/extension-api.d.ts:2675

+

packages/extension-api/src/extension-api.d.ts:2675

Detach?​

@@ -66,7 +66,7 @@

Run the container in the background

Source​

-

packages/extension-api/src/extension-api.d.ts:2712

+

packages/extension-api/src/extension-api.d.ts:2712

Domainname?​

@@ -74,7 +74,7 @@

The domain name to use for the container.

Source​

-

packages/extension-api/src/extension-api.d.ts:2629

+

packages/extension-api/src/extension-api.d.ts:2629

Entrypoint?​

@@ -83,7 +83,7 @@

The entry point for the container as a string or an array of strings.

If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile).

Source​

-

packages/extension-api/src/extension-api.d.ts:2682

+

packages/extension-api/src/extension-api.d.ts:2682

Env?​

@@ -91,7 +91,7 @@

A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value

Source​

-

packages/extension-api/src/extension-api.d.ts:2639

+

packages/extension-api/src/extension-api.d.ts:2639

EnvFiles?​

@@ -99,7 +99,7 @@

Environment files to use

Source​

-

packages/extension-api/src/extension-api.d.ts:2644

+

packages/extension-api/src/extension-api.d.ts:2644

ExposedPorts?​

@@ -109,7 +109,7 @@

Index signature​

[port: string]: object

Source​

-

packages/extension-api/src/extension-api.d.ts:2655

+

packages/extension-api/src/extension-api.d.ts:2655

HealthCheck?​

@@ -117,7 +117,7 @@

A test to perform to check that the container is healthy. See HealthConfig for usage details

Source​

-

packages/extension-api/src/extension-api.d.ts:2722

+

packages/extension-api/src/extension-api.d.ts:2722

HostConfig?​

@@ -125,7 +125,7 @@

Container configuration that depends on the host we are running on

Source​

-

packages/extension-api/src/extension-api.d.ts:2660

+

packages/extension-api/src/extension-api.d.ts:2660

Hostname?​

@@ -133,7 +133,7 @@

The hostname to use for the container, as a valid RFC 1123 hostname

Source​

-

packages/extension-api/src/extension-api.d.ts:2624

+

packages/extension-api/src/extension-api.d.ts:2624

Image?​

@@ -141,7 +141,7 @@

The name (or reference) of the image to use when creating the container

Source​

-

packages/extension-api/src/extension-api.d.ts:2665

+

packages/extension-api/src/extension-api.d.ts:2665

Labels?​

@@ -151,7 +151,7 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2649

+

packages/extension-api/src/extension-api.d.ts:2649

MacAddress?​

@@ -159,14 +159,14 @@

MAC address of the container.

Source​

-

packages/extension-api/src/extension-api.d.ts:2749

+

packages/extension-api/src/extension-api.d.ts:2749

NetworkConfig?​

optional NetworkConfig: NetworkingConfig

Source​

-

packages/extension-api/src/extension-api.d.ts:2773

+

packages/extension-api/src/extension-api.d.ts:2773

NetworkDisabled?​

@@ -174,7 +174,7 @@

Disable networking for the container.

Source​

-

packages/extension-api/src/extension-api.d.ts:2744

+

packages/extension-api/src/extension-api.d.ts:2744

OnBuild?​

@@ -182,7 +182,7 @@

ONBUILD metadata that were defined in the image's Dockerfile.

Source​

-

packages/extension-api/src/extension-api.d.ts:2754

+

packages/extension-api/src/extension-api.d.ts:2754

OpenStdin?​

@@ -190,7 +190,7 @@

Whether to open stdin (default false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2702

+

packages/extension-api/src/extension-api.d.ts:2702

Shell?​

@@ -198,7 +198,7 @@

Shell for when RUN, CMD, and ENTRYPOINT uses a shell.

Source​

-

packages/extension-api/src/extension-api.d.ts:2771

+

packages/extension-api/src/extension-api.d.ts:2771

StdinOnce?​

@@ -206,7 +206,7 @@

Close stdin after one attached client disconnects (deafult false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2707

+

packages/extension-api/src/extension-api.d.ts:2707

StopSignal?​

@@ -214,7 +214,7 @@

Signal to stop a container as a string or unsigned integer.

Source​

-

packages/extension-api/src/extension-api.d.ts:2759

+

packages/extension-api/src/extension-api.d.ts:2759

StopTimeout?​

@@ -223,7 +223,7 @@

Default: 10

Timeout to stop a container in seconds.

Source​

-

packages/extension-api/src/extension-api.d.ts:2766

+

packages/extension-api/src/extension-api.d.ts:2766

Tty?​

@@ -231,7 +231,7 @@

Attach standard streams to a TTY, including stdin if it is not closed (default false)

Source​

-

packages/extension-api/src/extension-api.d.ts:2670

+

packages/extension-api/src/extension-api.d.ts:2670

User?​

@@ -239,7 +239,7 @@

The user that commands are run as inside the container

Source​

-

packages/extension-api/src/extension-api.d.ts:2634

+

packages/extension-api/src/extension-api.d.ts:2634

Volumes?​

@@ -249,7 +249,7 @@

Index signature​

[volume: string]: object

Source​

-

packages/extension-api/src/extension-api.d.ts:2734

+

packages/extension-api/src/extension-api.d.ts:2734

WorkingDir?​

@@ -257,7 +257,7 @@

The working directory for commands to run in.

Source​

-

packages/extension-api/src/extension-api.d.ts:2739

+

packages/extension-api/src/extension-api.d.ts:2739

name?​

@@ -265,7 +265,7 @@

Assign the specified name to the container. Must match the regular expression/?[a-zA-Z0-9][a-zA-Z0-9_.-]+. If not speficied, the platform assigns a unique name to the container

Source​

-

packages/extension-api/src/extension-api.d.ts:2602

+

packages/extension-api/src/extension-api.d.ts:2602

platform?​

@@ -277,7 +277,7 @@

If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the Warnings field in the response, for example;

WARNING: The requested image's platform (linux/arm64/v8) does not
         match the detected host platform (linux/amd64) and no
         specific platform was requested

Source​

-

packages/extension-api/src/extension-api.d.ts:2619

+

packages/extension-api/src/extension-api.d.ts:2619

pod?​

@@ -285,7 +285,7 @@

Pod where to create the container in

Source​

-

packages/extension-api/src/extension-api.d.ts:2778

+

packages/extension-api/src/extension-api.d.ts:2778

start?​

@@ -293,6 +293,6 @@

Start the container immediately (default true)

Source​

-

packages/extension-api/src/extension-api.d.ts:2717

+

packages/extension-api/src/extension-api.d.ts:2717

\ No newline at end of file diff --git a/api/interfaces/ContainerCreateResult.html b/api/interfaces/ContainerCreateResult.html index 16335c5db1b..ca5b8d53b7f 100644 --- a/api/interfaces/ContainerCreateResult.html +++ b/api/interfaces/ContainerCreateResult.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

a string uniquely identifying the created container, which can be used to execute other methods on the container (containerEngine.deleteContainer, containerEngine.inspectContainer, containerEngine.startContainer, containerEngine.stopContainer, containerEngine.logsContainer)

Source​

-

packages/extension-api/src/extension-api.d.ts:2788

+

packages/extension-api/src/extension-api.d.ts:2788

\ No newline at end of file diff --git a/api/interfaces/ContainerEngineInfo.html b/api/interfaces/ContainerEngineInfo.html index 7c5ad94c20d..02b853b1b16 100644 --- a/api/interfaces/ContainerEngineInfo.html +++ b/api/interfaces/ContainerEngineInfo.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Percentage of idle CPUs (for Podman engines only)

Source​

-

packages/extension-api/src/extension-api.d.ts:3115

+

packages/extension-api/src/extension-api.d.ts:3115

cpus?​

@@ -34,7 +34,7 @@

number of CPUs available for the container engine

Source​

-

packages/extension-api/src/extension-api.d.ts:3111

+

packages/extension-api/src/extension-api.d.ts:3111

diskSize?​

@@ -42,7 +42,7 @@

Quantity of disk space available for the container engine (for Podman engines only)

Source​

-

packages/extension-api/src/extension-api.d.ts:3127

+

packages/extension-api/src/extension-api.d.ts:3127

diskUsed?​

@@ -50,7 +50,7 @@

Quantity of disk space used by the container engine (for Podman engines only)

Source​

-

packages/extension-api/src/extension-api.d.ts:3131

+

packages/extension-api/src/extension-api.d.ts:3131

engineId​

@@ -58,7 +58,7 @@

unique id identifying the container engine

Source​

-

packages/extension-api/src/extension-api.d.ts:3099

+

packages/extension-api/src/extension-api.d.ts:3099

engineName​

@@ -66,7 +66,7 @@

name of the container engine

Source​

-

packages/extension-api/src/extension-api.d.ts:3103

+

packages/extension-api/src/extension-api.d.ts:3103

engineType​

@@ -74,7 +74,7 @@

engine type, either 'podman' or 'docker'

Source​

-

packages/extension-api/src/extension-api.d.ts:3107

+

packages/extension-api/src/extension-api.d.ts:3107

memory?​

@@ -82,7 +82,7 @@

Quantity of memory available for the container engine

Source​

-

packages/extension-api/src/extension-api.d.ts:3119

+

packages/extension-api/src/extension-api.d.ts:3119

memoryUsed?​

@@ -90,6 +90,6 @@

Quantity of memory used by the container engine (for Podman engines only)

Source​

-

packages/extension-api/src/extension-api.d.ts:3123

+

packages/extension-api/src/extension-api.d.ts:3123

\ No newline at end of file diff --git a/api/interfaces/ContainerInfo.html b/api/interfaces/ContainerInfo.html index 4bbaea921bd..eb8fe72fd82 100644 --- a/api/interfaces/ContainerInfo.html +++ b/api/interfaces/ContainerInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

Command: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2031

+

packages/extension-api/src/extension-api.d.ts:2031

Created​

Created: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2032

+

packages/extension-api/src/extension-api.d.ts:2032

HostConfig​

@@ -42,28 +42,28 @@

NetworkMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2037

+

packages/extension-api/src/extension-api.d.ts:2037

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2027

+

packages/extension-api/src/extension-api.d.ts:2027

Image​

Image: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2029

+

packages/extension-api/src/extension-api.d.ts:2029

ImageID​

ImageID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2030

+

packages/extension-api/src/extension-api.d.ts:2030

Labels​

@@ -72,21 +72,21 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2034

+

packages/extension-api/src/extension-api.d.ts:2034

Mounts​

Mounts: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2043

+

packages/extension-api/src/extension-api.d.ts:2043

Names​

Names: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2028

+

packages/extension-api/src/extension-api.d.ts:2028

NetworkSettings​

@@ -99,48 +99,48 @@
Index signature​

[networkType: string]: NetworkInfo

Source​

-

packages/extension-api/src/extension-api.d.ts:2040

+

packages/extension-api/src/extension-api.d.ts:2040

Ports​

Ports: Port[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2033

+

packages/extension-api/src/extension-api.d.ts:2033

State​

State: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2035

+

packages/extension-api/src/extension-api.d.ts:2035

Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2036

+

packages/extension-api/src/extension-api.d.ts:2036

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2024

+

packages/extension-api/src/extension-api.d.ts:2024

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2025

+

packages/extension-api/src/extension-api.d.ts:2025

engineType​

engineType: "docker" | "podman"

Source​

-

packages/extension-api/src/extension-api.d.ts:2026

+

packages/extension-api/src/extension-api.d.ts:2026

\ No newline at end of file diff --git a/api/interfaces/ContainerInspectInfo.html b/api/interfaces/ContainerInspectInfo.html index 7bf6c202413..0f98ed70d2f 100644 --- a/api/interfaces/ContainerInspectInfo.html +++ b/api/interfaces/ContainerInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

AppArmorProfile: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2312

+

packages/extension-api/src/extension-api.d.ts:2312

Args​

Args: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2286

+

packages/extension-api/src/extension-api.d.ts:2286

Config​

@@ -116,28 +116,28 @@

WorkingDir: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2331

+

packages/extension-api/src/extension-api.d.ts:2331

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2284

+

packages/extension-api/src/extension-api.d.ts:2284

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2308

+

packages/extension-api/src/extension-api.d.ts:2308

ExecIDs?​

optional ExecIDs: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2313

+

packages/extension-api/src/extension-api.d.ts:2313

GraphDriver​

@@ -164,70 +164,70 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2315

+

packages/extension-api/src/extension-api.d.ts:2315

HostConfig​

HostConfig: HostConfig

Source​

-

packages/extension-api/src/extension-api.d.ts:2314

+

packages/extension-api/src/extension-api.d.ts:2314

HostnamePath​

HostnamePath: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2303

+

packages/extension-api/src/extension-api.d.ts:2303

HostsPath​

HostsPath: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2304

+

packages/extension-api/src/extension-api.d.ts:2304

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2283

+

packages/extension-api/src/extension-api.d.ts:2283

Image​

Image: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2301

+

packages/extension-api/src/extension-api.d.ts:2301

LogPath​

LogPath: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2305

+

packages/extension-api/src/extension-api.d.ts:2305

MountLabel​

MountLabel: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2310

+

packages/extension-api/src/extension-api.d.ts:2310

Mounts​

Mounts: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2323

+

packages/extension-api/src/extension-api.d.ts:2323

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2306

+

packages/extension-api/src/extension-api.d.ts:2306

NetworkSettings​

@@ -342,42 +342,42 @@

optional SecondaryIPv6Addresses: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2351

+

packages/extension-api/src/extension-api.d.ts:2351

Path​

Path: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2285

+

packages/extension-api/src/extension-api.d.ts:2285

Platform​

Platform: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2309

+

packages/extension-api/src/extension-api.d.ts:2309

ProcessLabel​

ProcessLabel: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2311

+

packages/extension-api/src/extension-api.d.ts:2311

ResolvConfPath​

ResolvConfPath: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2302

+

packages/extension-api/src/extension-api.d.ts:2302

RestartCount​

RestartCount: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2307

+

packages/extension-api/src/extension-api.d.ts:2307

State​

@@ -432,20 +432,20 @@

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2287

+

packages/extension-api/src/extension-api.d.ts:2287

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2281

+

packages/extension-api/src/extension-api.d.ts:2281

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2282

+

packages/extension-api/src/extension-api.d.ts:2282

\ No newline at end of file diff --git a/api/interfaces/ContainerJSONEvent.html b/api/interfaces/ContainerJSONEvent.html index 1ae1e3e1794..2dc8c782a4f 100644 --- a/api/interfaces/ContainerJSONEvent.html +++ b/api/interfaces/ContainerJSONEvent.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

optional Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2406

+

packages/extension-api/src/extension-api.d.ts:2406

id​

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2405

+

packages/extension-api/src/extension-api.d.ts:2405

status​

status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2404

+

packages/extension-api/src/extension-api.d.ts:2404

type​

type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2403

+

packages/extension-api/src/extension-api.d.ts:2403

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnection.html b/api/interfaces/ContainerProviderConnection.html index 3d167627665..0e6dd8e52c8 100644 --- a/api/interfaces/ContainerProviderConnection.html +++ b/api/interfaces/ContainerProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

endpoint: ContainerProviderConnectionEndpoint

Source​

-

packages/extension-api/src/extension-api.d.ts:286

+

packages/extension-api/src/extension-api.d.ts:286

lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

packages/extension-api/src/extension-api.d.ts:287

+

packages/extension-api/src/extension-api.d.ts:287

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:284

+

packages/extension-api/src/extension-api.d.ts:284

type​

type: "docker" | "podman"

Source​

-

packages/extension-api/src/extension-api.d.ts:285

+

packages/extension-api/src/extension-api.d.ts:285

Methods​

status()​

@@ -54,6 +54,6 @@

Returns​

ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:288

+

packages/extension-api/src/extension-api.d.ts:288

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnectionEndpoint.html b/api/interfaces/ContainerProviderConnectionEndpoint.html index 99a9fd2856e..dfcd202fd49 100644 --- a/api/interfaces/ContainerProviderConnectionEndpoint.html +++ b/api/interfaces/ContainerProviderConnectionEndpoint.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

socketPath: string

Source​

-

packages/extension-api/src/extension-api.d.ts:280

+

packages/extension-api/src/extension-api.d.ts:280

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnectionFactory.html b/api/interfaces/ContainerProviderConnectionFactory.html index ab57eb9a59e..3c44c3d3ec8 100644 --- a/api/interfaces/ContainerProviderConnectionFactory.html +++ b/api/interfaces/ContainerProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Inherited from​

ProviderConnectionFactory . creationButtonTitle

Source​

-

packages/extension-api/src/extension-api.d.ts:354

+

packages/extension-api/src/extension-api.d.ts:354

creationDisplayName?​

@@ -39,7 +39,7 @@

Inherited from​

ProviderConnectionFactory . creationDisplayName

Source​

-

packages/extension-api/src/extension-api.d.ts:351

+

packages/extension-api/src/extension-api.d.ts:351

Methods​

create()​

@@ -52,7 +52,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:360

+

packages/extension-api/src/extension-api.d.ts:360

initialize()?​

@@ -63,6 +63,6 @@

Inherited from​

ProviderConnectionFactory . initialize

Source​

-

packages/extension-api/src/extension-api.d.ts:348

+

packages/extension-api/src/extension-api.d.ts:348

\ No newline at end of file diff --git a/api/interfaces/ContainerStatsInfo.html b/api/interfaces/ContainerStatsInfo.html index 27e3452880d..80f7df19331 100644 --- a/api/interfaces/ContainerStatsInfo.html +++ b/api/interfaces/ContainerStatsInfo.html @@ -13,7 +13,7 @@ - + @@ -24,83 +24,83 @@

optional blkio_stats: BlkioStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2912

+

packages/extension-api/src/extension-api.d.ts:2912

cpu_stats​

cpu_stats: CPUStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2917

+

packages/extension-api/src/extension-api.d.ts:2917

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2907

+

packages/extension-api/src/extension-api.d.ts:2907

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2908

+

packages/extension-api/src/extension-api.d.ts:2908

memory_stats​

memory_stats: MemoryStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2916

+

packages/extension-api/src/extension-api.d.ts:2916

networks​

networks: NetworkStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2915

+

packages/extension-api/src/extension-api.d.ts:2915

num_procs​

num_procs: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2913

+

packages/extension-api/src/extension-api.d.ts:2913

pids_stats?​

optional pids_stats: PidsStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2911

+

packages/extension-api/src/extension-api.d.ts:2911

precpu_stats​

precpu_stats: CPUStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2918

+

packages/extension-api/src/extension-api.d.ts:2918

preread​

preread: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2910

+

packages/extension-api/src/extension-api.d.ts:2910

read​

read: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2909

+

packages/extension-api/src/extension-api.d.ts:2909

storage_stats?​

optional storage_stats: StorageStats

Source​

-

packages/extension-api/src/extension-api.d.ts:2914

+

packages/extension-api/src/extension-api.d.ts:2914

\ No newline at end of file diff --git a/api/interfaces/CustomPick.html b/api/interfaces/CustomPick.html index b897e0d1ec9..bb64172ed9a 100644 --- a/api/interfaces/CustomPick.html +++ b/api/interfaces/CustomPick.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ The items are rendered using a custom UI.

If multiple items can be selected at the same time. Defaults to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:1151

+

packages/extension-api/src/extension-api.d.ts:1151

description?​

@@ -37,7 +37,7 @@ The items are rendered using a custom UI.

An optional human-readable string which is rendered less prominent in a separate line.

Source​

-

packages/extension-api/src/extension-api.d.ts:1139

+

packages/extension-api/src/extension-api.d.ts:1139

hideItemSections​

@@ -47,7 +47,7 @@ The items are rendered using a custom UI.

The user can still open them by clicking on the 'show more' button. Defaults to false.

Source​

-

packages/extension-api/src/extension-api.d.ts:1157

+

packages/extension-api/src/extension-api.d.ts:1157

icon?​

@@ -55,7 +55,7 @@ Defaults to false.

An optional base64 PNG image

Source​

-

packages/extension-api/src/extension-api.d.ts:1143

+

packages/extension-api/src/extension-api.d.ts:1143

items​

@@ -63,7 +63,7 @@ Defaults to false.

Items to pick from. This can be read and updated by the extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:1147

+

packages/extension-api/src/extension-api.d.ts:1147

minHeight?​

@@ -73,7 +73,7 @@ Defaults to false.

It must be set using pixels or percentage (e.g 100px or 50%) Use it carefully as it could break the layout.

Source​

-

packages/extension-api/src/extension-api.d.ts:1163

+

packages/extension-api/src/extension-api.d.ts:1163

onDidConfirmSelection​

@@ -81,7 +81,7 @@ Use it carefully as it could break the layout.

An event signaling when the user indicated confirmation of the selected item(s) index(es).

Source​

-

packages/extension-api/src/extension-api.d.ts:1167

+

packages/extension-api/src/extension-api.d.ts:1167

onDidHide​

@@ -89,7 +89,7 @@ Use it carefully as it could break the layout.

An event signaling when this input UI is hidden.

Source​

-

packages/extension-api/src/extension-api.d.ts:1171

+

packages/extension-api/src/extension-api.d.ts:1171

title?​

@@ -97,7 +97,7 @@ Use it carefully as it could break the layout.

An optional human-readable string which is rendered prominent.

Source​

-

packages/extension-api/src/extension-api.d.ts:1135

+

packages/extension-api/src/extension-api.d.ts:1135

Methods​

dispose()​

@@ -108,7 +108,7 @@ Use it carefully as it could break the layout.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1185

+

packages/extension-api/src/extension-api.d.ts:1185

hide()​

@@ -118,7 +118,7 @@ Use it carefully as it could break the layout.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1179

+

packages/extension-api/src/extension-api.d.ts:1179

show()​

@@ -128,6 +128,6 @@ Use it carefully as it could break the layout.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1175

+

packages/extension-api/src/extension-api.d.ts:1175

\ No newline at end of file diff --git a/api/interfaces/CustomPickItem.html b/api/interfaces/CustomPickItem.html index f41c15f33c7..e22dcd66f0a 100644 --- a/api/interfaces/CustomPickItem.html +++ b/api/interfaces/CustomPickItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ a list of items.

A human-readable string which is rendered less prominent in the same line.

Source​

-

packages/extension-api/src/extension-api.d.ts:1112

+

packages/extension-api/src/extension-api.d.ts:1112

markDownContent​

@@ -35,7 +35,7 @@ a list of items.

A human-readable string which is rendered in a separate line. (Markdown format)

Source​

-

packages/extension-api/src/extension-api.d.ts:1116

+

packages/extension-api/src/extension-api.d.ts:1116

sections?​

@@ -43,7 +43,7 @@ a list of items.

Optional sections that will be rendered in separate lines

Source​

-

packages/extension-api/src/extension-api.d.ts:1120

+

packages/extension-api/src/extension-api.d.ts:1120

selected?​

@@ -51,7 +51,7 @@ a list of items.

Optional flag indicating if this item is selected initially

Source​

-

packages/extension-api/src/extension-api.d.ts:1124

+

packages/extension-api/src/extension-api.d.ts:1124

title​

@@ -59,6 +59,6 @@ a list of items.

A human-readable string which is rendered prominent.

Source​

-

packages/extension-api/src/extension-api.d.ts:1108

+

packages/extension-api/src/extension-api.d.ts:1108

\ No newline at end of file diff --git a/api/interfaces/CustomPickSectionItem.html b/api/interfaces/CustomPickSectionItem.html index eab21c6cb3c..41f7f464285 100644 --- a/api/interfaces/CustomPickSectionItem.html +++ b/api/interfaces/CustomPickSectionItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ a list of items.

A human-readable string which is rendered in a separate line.

Source​

-

packages/extension-api/src/extension-api.d.ts:1092

+

packages/extension-api/src/extension-api.d.ts:1092

markDownContent?​

@@ -35,7 +35,7 @@ a list of items.

A human-readable string which is rendered in a separate line. (Markdown format)

Source​

-

packages/extension-api/src/extension-api.d.ts:1097

+

packages/extension-api/src/extension-api.d.ts:1097

title​

@@ -43,6 +43,6 @@ a list of items.

A human-readable string which is rendered prominent.

Source​

-

packages/extension-api/src/extension-api.d.ts:1087

+

packages/extension-api/src/extension-api.d.ts:1087

\ No newline at end of file diff --git a/api/interfaces/DeviceRequest.html b/api/interfaces/DeviceRequest.html index 1dbb7a785b9..a64d0fc3b24 100644 --- a/api/interfaces/DeviceRequest.html +++ b/api/interfaces/DeviceRequest.html @@ -13,7 +13,7 @@ - + @@ -24,28 +24,28 @@

optional Capabilities: string[][]

Source​

-

packages/extension-api/src/extension-api.d.ts:2163

+

packages/extension-api/src/extension-api.d.ts:2163

Count?​

optional Count: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2161

+

packages/extension-api/src/extension-api.d.ts:2161

DeviceIDs?​

optional DeviceIDs: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2162

+

packages/extension-api/src/extension-api.d.ts:2162

Driver?​

optional Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2160

+

packages/extension-api/src/extension-api.d.ts:2160

Options?​

@@ -54,6 +54,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2164

+

packages/extension-api/src/extension-api.d.ts:2164

\ No newline at end of file diff --git a/api/interfaces/EndpointIPAMConfig.html b/api/interfaces/EndpointIPAMConfig.html index 8551c5c3152..25c536dba73 100644 --- a/api/interfaces/EndpointIPAMConfig.html +++ b/api/interfaces/EndpointIPAMConfig.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional IPv4Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2497

+

packages/extension-api/src/extension-api.d.ts:2497

IPv6Address?​

optional IPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2498

+

packages/extension-api/src/extension-api.d.ts:2498

LinkLocalIPs?​

optional LinkLocalIPs: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2499

+

packages/extension-api/src/extension-api.d.ts:2499

\ No newline at end of file diff --git a/api/interfaces/EndpointSettings.html b/api/interfaces/EndpointSettings.html index 41824689113..f083e2e27ef 100644 --- a/api/interfaces/EndpointSettings.html +++ b/api/interfaces/EndpointSettings.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

optional Aliases: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2515

+

packages/extension-api/src/extension-api.d.ts:2515

DNSNames?​

@@ -36,7 +36,7 @@ aliases, container short ID, and hostname.

appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

Source​

-

packages/extension-api/src/extension-api.d.ts:2570

+

packages/extension-api/src/extension-api.d.ts:2570

DriverOpts?​

@@ -46,7 +46,7 @@ appending .<network-name>. For instance, if container name is

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2560

+

packages/extension-api/src/extension-api.d.ts:2560

EndpointID?​

@@ -54,7 +54,7 @@ appending .<network-name>. For instance, if container name is

Unique ID for the service endpoint in a Sandbox.

Source​

-

packages/extension-api/src/extension-api.d.ts:2525

+

packages/extension-api/src/extension-api.d.ts:2525

Gateway?​

@@ -62,7 +62,7 @@ appending .<network-name>. For instance, if container name is

Gateway address for this network.

Source​

-

packages/extension-api/src/extension-api.d.ts:2530

+

packages/extension-api/src/extension-api.d.ts:2530

GlobalIPv6Address?​

@@ -70,7 +70,7 @@ appending .<network-name>. For instance, if container name is

Global IPv6 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2550

+

packages/extension-api/src/extension-api.d.ts:2550

GlobalIPv6PrefixLen?​

@@ -78,7 +78,7 @@ appending .<network-name>. For instance, if container name is

Mask length of the global IPv6 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2555

+

packages/extension-api/src/extension-api.d.ts:2555

IPAMConfig?​

@@ -86,7 +86,7 @@ appending .<network-name>. For instance, if container name is

EndpointIPAMConfig represents an endpoint's IPAM configuration.

Source​

-

packages/extension-api/src/extension-api.d.ts:2506

+

packages/extension-api/src/extension-api.d.ts:2506

IPAddress?​

@@ -94,7 +94,7 @@ appending .<network-name>. For instance, if container name is

IPv4 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2535

+

packages/extension-api/src/extension-api.d.ts:2535

IPPrefixLen?​

@@ -102,7 +102,7 @@ appending .<network-name>. For instance, if container name is

Mask length of the IPv4 address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2540

+

packages/extension-api/src/extension-api.d.ts:2540

IPv6Gateway?​

@@ -110,14 +110,14 @@ appending .<network-name>. For instance, if container name is

IPv6 gateway address.

Source​

-

packages/extension-api/src/extension-api.d.ts:2545

+

packages/extension-api/src/extension-api.d.ts:2545

optional Links: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2508

+

packages/extension-api/src/extension-api.d.ts:2508

MacAddress?​

@@ -125,7 +125,7 @@ appending .<network-name>. For instance, if container name is

MAC address for the endpoint on this network. The network driver might ignore this parameter.

Source​

-

packages/extension-api/src/extension-api.d.ts:2513

+

packages/extension-api/src/extension-api.d.ts:2513

NetworkID?​

@@ -133,6 +133,6 @@ appending .<network-name>. For instance, if container name is

Unique ID of the network.

Source​

-

packages/extension-api/src/extension-api.d.ts:2520

+

packages/extension-api/src/extension-api.d.ts:2520

\ No newline at end of file diff --git a/api/interfaces/Event.html b/api/interfaces/Event.html index d0e66cc4226..c16fca36862 100644 --- a/api/interfaces/Event.html +++ b/api/interfaces/Event.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:125

+

packages/extension-api/src/extension-api.d.ts:125

\ No newline at end of file diff --git a/api/interfaces/ExtensionContext.html b/api/interfaces/ExtensionContext.html index c04e3554ad2..ec12b8190b9 100644 --- a/api/interfaces/ExtensionContext.html +++ b/api/interfaces/ExtensionContext.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The uri of the directory containing the extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:165

+

packages/extension-api/src/extension-api.d.ts:165

secrets​

@@ -33,7 +33,7 @@

A storage utility for secrets. Secrets are persisted across reloads.

Source​

-

packages/extension-api/src/extension-api.d.ts:170

+

packages/extension-api/src/extension-api.d.ts:170

storagePath​

@@ -43,13 +43,13 @@ The directory might not exist on disk and creation is up to the extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:160

+

packages/extension-api/src/extension-api.d.ts:160

subscriptions​

readonly subscriptions: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:153

+

packages/extension-api/src/extension-api.d.ts:153

\ No newline at end of file diff --git a/api/interfaces/FileSystemWatcher.html b/api/interfaces/FileSystemWatcher.html index e9ba498dade..3573197543e 100644 --- a/api/interfaces/FileSystemWatcher.html +++ b/api/interfaces/FileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -29,21 +29,21 @@

readonly onDidChange: Event <Uri>

Source​

-

packages/extension-api/src/extension-api.d.ts:1410

+

packages/extension-api/src/extension-api.d.ts:1410

onDidCreate​

readonly onDidCreate: Event <Uri>

Source​

-

packages/extension-api/src/extension-api.d.ts:1409

+

packages/extension-api/src/extension-api.d.ts:1409

onDidDelete​

readonly onDidDelete: Event <Uri>

Source​

-

packages/extension-api/src/extension-api.d.ts:1411

+

packages/extension-api/src/extension-api.d.ts:1411

Methods​

dispose()​

@@ -55,6 +55,6 @@

Inherited from​

Disposable . dispose

Source​

-

packages/extension-api/src/extension-api.d.ts:97

+

packages/extension-api/src/extension-api.d.ts:97

\ No newline at end of file diff --git a/api/interfaces/GenerateKubeResult.html b/api/interfaces/GenerateKubeResult.html index 510f945e7cf..0ade444fe1d 100644 --- a/api/interfaces/GenerateKubeResult.html +++ b/api/interfaces/GenerateKubeResult.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

yaml: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1875

+

packages/extension-api/src/extension-api.d.ts:1875

\ No newline at end of file diff --git a/api/interfaces/HealthCheckLog.html b/api/interfaces/HealthCheckLog.html index f5437cd09da..71ab4ab2a07 100644 --- a/api/interfaces/HealthCheckLog.html +++ b/api/interfaces/HealthCheckLog.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

End time as a string

Source​

-

packages/extension-api/src/extension-api.d.ts:2269

+

packages/extension-api/src/extension-api.d.ts:2269

ExitCode​

@@ -34,7 +34,7 @@

Exitcode is 0 or 1

Source​

-

packages/extension-api/src/extension-api.d.ts:2273

+

packages/extension-api/src/extension-api.d.ts:2273

Output​

@@ -42,7 +42,7 @@

Output is the stdout/stderr from the healthcheck command

Source​

-

packages/extension-api/src/extension-api.d.ts:2277

+

packages/extension-api/src/extension-api.d.ts:2277

Start​

@@ -50,6 +50,6 @@

Start time as string

Source​

-

packages/extension-api/src/extension-api.d.ts:2265

+

packages/extension-api/src/extension-api.d.ts:2265

\ No newline at end of file diff --git a/api/interfaces/HealthCheckResults.html b/api/interfaces/HealthCheckResults.html index 987352bc517..2de8844f5b0 100644 --- a/api/interfaces/HealthCheckResults.html +++ b/api/interfaces/HealthCheckResults.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

FailingStreak is the number of consecutive failed healthchecks

Source​

-

packages/extension-api/src/extension-api.d.ts:2251

+

packages/extension-api/src/extension-api.d.ts:2251

Log​

@@ -34,7 +34,7 @@

Log describes healthcheck attempts and results

Source​

-

packages/extension-api/src/extension-api.d.ts:2255

+

packages/extension-api/src/extension-api.d.ts:2255

Status​

@@ -42,6 +42,6 @@

Status is starting, healthy or unhealthy

Source​

-

packages/extension-api/src/extension-api.d.ts:2247

+

packages/extension-api/src/extension-api.d.ts:2247

\ No newline at end of file diff --git a/api/interfaces/HealthConfig.html b/api/interfaces/HealthConfig.html index 89675eff13d..341a769d1eb 100644 --- a/api/interfaces/HealthConfig.html +++ b/api/interfaces/HealthConfig.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ To get health check result you can use Example​ 
// Set interval to 1 second
Interval?: 1000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2465

+

packages/extension-api/src/extension-api.d.ts:2465

Retries?​

@@ -39,7 +39,7 @@ To get health check result you can use Example​ 
// Set retries to 3
Retries?: 3;

Source​

-

packages/extension-api/src/extension-api.d.ts:2493

+

packages/extension-api/src/extension-api.d.ts:2493

StartPeriod?​

@@ -50,7 +50,7 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

Example​

// Set start period to 2 seconds
StartPeriod?: 2000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2484

+

packages/extension-api/src/extension-api.d.ts:2484

Test?​

@@ -63,7 +63,7 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

// Execute command in host system
Test?: ["CMD", "curl", "http://localhost"];
// Podman will execute the command inside the target container and wait for either a "0" or "failure  exit" code.
Test?: ["CMD-SHELL", "curl http://localhost || exit 1"];

Source​

-

packages/extension-api/src/extension-api.d.ts:2456

+

packages/extension-api/src/extension-api.d.ts:2456

Timeout?​

@@ -73,6 +73,6 @@ be 0 or at least 1000000 (1 ms). 0 means inherit.

Example​

// Set timeout to 5 seconds
Timeout?: 5000000000;

Source​

-

packages/extension-api/src/extension-api.d.ts:2474

+

packages/extension-api/src/extension-api.d.ts:2474

\ No newline at end of file diff --git a/api/interfaces/HostConfig.html b/api/interfaces/HostConfig.html index 1dbf031ed94..31b05485cd2 100644 --- a/api/interfaces/HostConfig.html +++ b/api/interfaces/HostConfig.html @@ -13,7 +13,7 @@ - + @@ -24,259 +24,259 @@

optional AutoRemove: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2168

+

packages/extension-api/src/extension-api.d.ts:2168

Binds?​

optional Binds: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2169

+

packages/extension-api/src/extension-api.d.ts:2169

BlkioDeviceReadBps?​

optional BlkioDeviceReadBps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2212

+

packages/extension-api/src/extension-api.d.ts:2212

BlkioDeviceReadIOps?​

optional BlkioDeviceReadIOps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2214

+

packages/extension-api/src/extension-api.d.ts:2214

BlkioDeviceWriteBps?​

optional BlkioDeviceWriteBps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2213

+

packages/extension-api/src/extension-api.d.ts:2213

BlkioDeviceWriteIOps?​

optional BlkioDeviceWriteIOps: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2215

+

packages/extension-api/src/extension-api.d.ts:2215

BlkioWeight?​

optional BlkioWeight: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2210

+

packages/extension-api/src/extension-api.d.ts:2210

BlkioWeightDevice?​

optional BlkioWeightDevice: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2211

+

packages/extension-api/src/extension-api.d.ts:2211

CapAdd?​

optional CapAdd: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2181

+

packages/extension-api/src/extension-api.d.ts:2181

CapDrop?​

optional CapDrop: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2182

+

packages/extension-api/src/extension-api.d.ts:2182

Cgroup?​

optional Cgroup: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2189

+

packages/extension-api/src/extension-api.d.ts:2189

CgroupParent?​

optional CgroupParent: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2209

+

packages/extension-api/src/extension-api.d.ts:2209

ConsoleSize?​

optional ConsoleSize: number[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2204

+

packages/extension-api/src/extension-api.d.ts:2204

ContainerIDFile?​

optional ContainerIDFile: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2170

+

packages/extension-api/src/extension-api.d.ts:2170

CpuCount?​

optional CpuCount: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2234

+

packages/extension-api/src/extension-api.d.ts:2234

CpuPercent?​

optional CpuPercent: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2235

+

packages/extension-api/src/extension-api.d.ts:2235

CpuPeriod?​

optional CpuPeriod: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2216

+

packages/extension-api/src/extension-api.d.ts:2216

CpuQuota?​

optional CpuQuota: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2217

+

packages/extension-api/src/extension-api.d.ts:2217

CpuRealtimePeriod?​

optional CpuRealtimePeriod: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2236

+

packages/extension-api/src/extension-api.d.ts:2236

CpuRealtimeRuntime?​

optional CpuRealtimeRuntime: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2237

+

packages/extension-api/src/extension-api.d.ts:2237

CpuShares?​

optional CpuShares: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2208

+

packages/extension-api/src/extension-api.d.ts:2208

CpusetCpus?​

optional CpusetCpus: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2218

+

packages/extension-api/src/extension-api.d.ts:2218

CpusetMems?​

optional CpusetMems: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2219

+

packages/extension-api/src/extension-api.d.ts:2219

DeviceCgroupRules?​

optional DeviceCgroupRules: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2221

+

packages/extension-api/src/extension-api.d.ts:2221

DeviceRequests?​

optional DeviceRequests: DeviceRequest[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2222

+

packages/extension-api/src/extension-api.d.ts:2222

Devices?​

optional Devices: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2220

+

packages/extension-api/src/extension-api.d.ts:2220

DiskQuota?​

optional DiskQuota: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2223

+

packages/extension-api/src/extension-api.d.ts:2223

Dns?​

optional Dns: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2183

+

packages/extension-api/src/extension-api.d.ts:2183

DnsOptions?​

optional DnsOptions: unknown[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2184

+

packages/extension-api/src/extension-api.d.ts:2184

DnsSearch?​

optional DnsSearch: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2185

+

packages/extension-api/src/extension-api.d.ts:2185

ExtraHosts?​

optional ExtraHosts: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2186

+

packages/extension-api/src/extension-api.d.ts:2186

GroupAdd?​

optional GroupAdd: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2187

+

packages/extension-api/src/extension-api.d.ts:2187

Init?​

optional Init: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2231

+

packages/extension-api/src/extension-api.d.ts:2231

IpcMode?​

optional IpcMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2188

+

packages/extension-api/src/extension-api.d.ts:2188

Isolation?​

optional Isolation: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2205

+

packages/extension-api/src/extension-api.d.ts:2205

KernelMemory?​

optional KernelMemory: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2224

+

packages/extension-api/src/extension-api.d.ts:2224

optional Links: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2190

+

packages/extension-api/src/extension-api.d.ts:2190

LogConfig?​

@@ -291,154 +291,154 @@

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2171

+

packages/extension-api/src/extension-api.d.ts:2171

MaskedPaths?​

optional MaskedPaths: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2206

+

packages/extension-api/src/extension-api.d.ts:2206

Memory?​

optional Memory: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2225

+

packages/extension-api/src/extension-api.d.ts:2225

MemoryReservation?​

optional MemoryReservation: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2226

+

packages/extension-api/src/extension-api.d.ts:2226

MemorySwap?​

optional MemorySwap: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2227

+

packages/extension-api/src/extension-api.d.ts:2227

MemorySwappiness?​

optional MemorySwappiness: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2228

+

packages/extension-api/src/extension-api.d.ts:2228

Mounts?​

optional Mounts: MountConfig

Source​

-

packages/extension-api/src/extension-api.d.ts:2180

+

packages/extension-api/src/extension-api.d.ts:2180

NanoCpus?​

optional NanoCpus: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2229

+

packages/extension-api/src/extension-api.d.ts:2229

NetworkMode?​

optional NetworkMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2175

+

packages/extension-api/src/extension-api.d.ts:2175

OomKillDisable?​

optional OomKillDisable: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2230

+

packages/extension-api/src/extension-api.d.ts:2230

OomScoreAdj?​

optional OomScoreAdj: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2191

+

packages/extension-api/src/extension-api.d.ts:2191

PidMode?​

optional PidMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2192

+

packages/extension-api/src/extension-api.d.ts:2192

PidsLimit?​

optional PidsLimit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2232

+

packages/extension-api/src/extension-api.d.ts:2232

PortBindings?​

optional PortBindings: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2176

+

packages/extension-api/src/extension-api.d.ts:2176

Privileged?​

optional Privileged: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2193

+

packages/extension-api/src/extension-api.d.ts:2193

PublishAllPorts?​

optional PublishAllPorts: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2194

+

packages/extension-api/src/extension-api.d.ts:2194

ReadonlyPaths?​

optional ReadonlyPaths: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2207

+

packages/extension-api/src/extension-api.d.ts:2207

ReadonlyRootfs?​

optional ReadonlyRootfs: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2195

+

packages/extension-api/src/extension-api.d.ts:2195

RestartPolicy?​

optional RestartPolicy: HostRestartPolicy

Source​

-

packages/extension-api/src/extension-api.d.ts:2177

+

packages/extension-api/src/extension-api.d.ts:2177

Runtime?​

optional Runtime: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2203

+

packages/extension-api/src/extension-api.d.ts:2203

SecurityOpt?​

optional SecurityOpt: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2196

+

packages/extension-api/src/extension-api.d.ts:2196

ShmSize?​

optional ShmSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2201

+

packages/extension-api/src/extension-api.d.ts:2201

StorageOpt?​

@@ -447,7 +447,7 @@

Index signature​

[option: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2197

+

packages/extension-api/src/extension-api.d.ts:2197

Sysctls?​

@@ -456,7 +456,7 @@

Index signature​

[index: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2202

+

packages/extension-api/src/extension-api.d.ts:2202

Tmpfs?​

@@ -465,41 +465,41 @@

Index signature​

[dir: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2198

+

packages/extension-api/src/extension-api.d.ts:2198

UTSMode?​

optional UTSMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2199

+

packages/extension-api/src/extension-api.d.ts:2199

Ulimits?​

optional Ulimits: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2233

+

packages/extension-api/src/extension-api.d.ts:2233

UsernsMode?​

optional UsernsMode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2200

+

packages/extension-api/src/extension-api.d.ts:2200

VolumeDriver?​

optional VolumeDriver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2178

+

packages/extension-api/src/extension-api.d.ts:2178

VolumesFrom?​

optional VolumesFrom: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2179

+

packages/extension-api/src/extension-api.d.ts:2179

\ No newline at end of file diff --git a/api/interfaces/HostRestartPolicy.html b/api/interfaces/HostRestartPolicy.html index f9ac2db5a69..2cd2a83971a 100644 --- a/api/interfaces/HostRestartPolicy.html +++ b/api/interfaces/HostRestartPolicy.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional MaximumRetryCount: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2124

+

packages/extension-api/src/extension-api.d.ts:2124

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2123

+

packages/extension-api/src/extension-api.d.ts:2123

\ No newline at end of file diff --git a/api/interfaces/IPAM.html b/api/interfaces/IPAM.html index 641a7982d97..6fbdf2b41ed 100644 --- a/api/interfaces/IPAM.html +++ b/api/interfaces/IPAM.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional Config: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1998

+

packages/extension-api/src/extension-api.d.ts:1998

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1997

+

packages/extension-api/src/extension-api.d.ts:1997

Options?​

@@ -40,6 +40,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1999

+

packages/extension-api/src/extension-api.d.ts:1999

\ No newline at end of file diff --git a/api/interfaces/ImageCheck.html b/api/interfaces/ImageCheck.html index 4b7d924ad20..fdc3deaf9cb 100644 --- a/api/interfaces/ImageCheck.html +++ b/api/interfaces/ImageCheck.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

full description of the error/recommendation

Source​

-

packages/extension-api/src/extension-api.d.ts:4126

+

packages/extension-api/src/extension-api.d.ts:4126

name​

@@ -34,7 +34,7 @@

a short and descriptive name for the error/recommendation

Source​

-

packages/extension-api/src/extension-api.d.ts:4114

+

packages/extension-api/src/extension-api.d.ts:4114

severity?​

@@ -42,7 +42,7 @@

severity of the error/recommendation, when the status is failed

Source​

-

packages/extension-api/src/extension-api.d.ts:4122

+

packages/extension-api/src/extension-api.d.ts:4122

status​

@@ -50,6 +50,6 @@

either the feedback is positive or negative

Source​

-

packages/extension-api/src/extension-api.d.ts:4118

+

packages/extension-api/src/extension-api.d.ts:4118

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProvider.html b/api/interfaces/ImageCheckerProvider.html index 0bb0cb3662f..e88c2345fe9 100644 --- a/api/interfaces/ImageCheckerProvider.html +++ b/api/interfaces/ImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

ProviderResult <ImageChecks>

the complete result of the analyze, either synchronously of through a Promise

Source​

-

packages/extension-api/src/extension-api.d.ts:4149

+

packages/extension-api/src/extension-api.d.ts:4149

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProviderMetadata.html b/api/interfaces/ImageCheckerProviderMetadata.html index d7fc86e4c73..aa6bfb55d81 100644 --- a/api/interfaces/ImageCheckerProviderMetadata.html +++ b/api/interfaces/ImageCheckerProviderMetadata.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

readonly label: string

Source​

-

packages/extension-api/src/extension-api.d.ts:4153

+

packages/extension-api/src/extension-api.d.ts:4153

\ No newline at end of file diff --git a/api/interfaces/ImageChecks.html b/api/interfaces/ImageChecks.html index d5de2becf70..e9fef90d22a 100644 --- a/api/interfaces/ImageChecks.html +++ b/api/interfaces/ImageChecks.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

the list of errors/recommendations found during the image check

Source​

-

packages/extension-api/src/extension-api.d.ts:4136

+

packages/extension-api/src/extension-api.d.ts:4136

\ No newline at end of file diff --git a/api/interfaces/ImageInfo.html b/api/interfaces/ImageInfo.html index c04c63af8dd..0eb625b9114 100644 --- a/api/interfaces/ImageInfo.html +++ b/api/interfaces/ImageInfo.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

Containers: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1907

+

packages/extension-api/src/extension-api.d.ts:1907

Created​

Created: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1902

+

packages/extension-api/src/extension-api.d.ts:1902

Digest​

Digest: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1909

+

packages/extension-api/src/extension-api.d.ts:1909

History?​

optional History: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1908

+

packages/extension-api/src/extension-api.d.ts:1908

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1898

+

packages/extension-api/src/extension-api.d.ts:1898

Labels​

@@ -61,69 +61,69 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1906

+

packages/extension-api/src/extension-api.d.ts:1906

ParentId​

ParentId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1899

+

packages/extension-api/src/extension-api.d.ts:1899

RepoDigests?​

optional RepoDigests: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1901

+

packages/extension-api/src/extension-api.d.ts:1901

RepoTags​

RepoTags: undefined | string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1900

+

packages/extension-api/src/extension-api.d.ts:1900

SharedSize​

SharedSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1905

+

packages/extension-api/src/extension-api.d.ts:1905

Size​

Size: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1903

+

packages/extension-api/src/extension-api.d.ts:1903

VirtualSize​

VirtualSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1904

+

packages/extension-api/src/extension-api.d.ts:1904

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1896

+

packages/extension-api/src/extension-api.d.ts:1896

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1897

+

packages/extension-api/src/extension-api.d.ts:1897

isManifest?​

optional isManifest: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:1912

+

packages/extension-api/src/extension-api.d.ts:1912

\ No newline at end of file diff --git a/api/interfaces/ImageInspectInfo.html b/api/interfaces/ImageInspectInfo.html index c48bb46e0a3..919e2b5a492 100644 --- a/api/interfaces/ImageInspectInfo.html +++ b/api/interfaces/ImageInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

Architecture: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1969

+

packages/extension-api/src/extension-api.d.ts:1969

Author​

Author: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1947

+

packages/extension-api/src/extension-api.d.ts:1947

Comment​

Comment: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1922

+

packages/extension-api/src/extension-api.d.ts:1922

Config​

@@ -127,14 +127,14 @@

WorkingDir: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1948

+

packages/extension-api/src/extension-api.d.ts:1948

Container​

Container: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1924

+

packages/extension-api/src/extension-api.d.ts:1924

ContainerConfig​

@@ -223,21 +223,21 @@

WorkingDir: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1925

+

packages/extension-api/src/extension-api.d.ts:1925

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1923

+

packages/extension-api/src/extension-api.d.ts:1923

DockerVersion​

DockerVersion: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1946

+

packages/extension-api/src/extension-api.d.ts:1946

GraphDriver​

@@ -264,42 +264,42 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1973

+

packages/extension-api/src/extension-api.d.ts:1973

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1918

+

packages/extension-api/src/extension-api.d.ts:1918

Os​

Os: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1970

+

packages/extension-api/src/extension-api.d.ts:1970

Parent​

Parent: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1921

+

packages/extension-api/src/extension-api.d.ts:1921

RepoDigests​

RepoDigests: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1920

+

packages/extension-api/src/extension-api.d.ts:1920

RepoTags​

RepoTags: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:1919

+

packages/extension-api/src/extension-api.d.ts:1919

RootFS​

@@ -318,34 +318,34 @@

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1981

+

packages/extension-api/src/extension-api.d.ts:1981

Size​

Size: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1971

+

packages/extension-api/src/extension-api.d.ts:1971

VirtualSize​

VirtualSize: number

Source​

-

packages/extension-api/src/extension-api.d.ts:1972

+

packages/extension-api/src/extension-api.d.ts:1972

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1916

+

packages/extension-api/src/extension-api.d.ts:1916

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1917

+

packages/extension-api/src/extension-api.d.ts:1917

\ No newline at end of file diff --git a/api/interfaces/InputBoxOptions.html b/api/interfaces/InputBoxOptions.html index e354f6fef87..dc188107e89 100644 --- a/api/interfaces/InputBoxOptions.html +++ b/api/interfaces/InputBoxOptions.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@

Set to true to keep the input box open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

Source​

-

packages/extension-api/src/extension-api.d.ts:918

+

packages/extension-api/src/extension-api.d.ts:918

markdownDescription?​

@@ -35,7 +35,7 @@ This setting is ignored on iPad and is always false.

A description of the field to be show (Markdown format)

Source​

-

packages/extension-api/src/extension-api.d.ts:902

+

packages/extension-api/src/extension-api.d.ts:902

multiline?​

@@ -43,7 +43,7 @@ This setting is ignored on iPad and is always false.

Set to true when value represents a multi line content.

Source​

-

packages/extension-api/src/extension-api.d.ts:923

+

packages/extension-api/src/extension-api.d.ts:923

password?​

@@ -51,7 +51,7 @@ This setting is ignored on iPad and is always false.

Controls if a password input is shown. Password input hides the typed text.

Source​

-

packages/extension-api/src/extension-api.d.ts:912

+

packages/extension-api/src/extension-api.d.ts:912

placeHolder?​

@@ -59,7 +59,7 @@ This setting is ignored on iPad and is always false.

An optional string to show as placeholder in the input box to guide the user what to type.

Source​

-

packages/extension-api/src/extension-api.d.ts:907

+

packages/extension-api/src/extension-api.d.ts:907

prompt?​

@@ -67,7 +67,7 @@ This setting is ignored on iPad and is always false.

The text to display underneath the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:897

+

packages/extension-api/src/extension-api.d.ts:897

title?​

@@ -75,7 +75,7 @@ This setting is ignored on iPad and is always false.

An optional string that represents the title of the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:879

+

packages/extension-api/src/extension-api.d.ts:879

value?​

@@ -83,7 +83,7 @@ This setting is ignored on iPad and is always false.

The value to pre-fill in the input box.

Source​

-

packages/extension-api/src/extension-api.d.ts:884

+

packages/extension-api/src/extension-api.d.ts:884

valueSelection?​

@@ -94,7 +94,7 @@ first is the inclusive start index and the second the exclusive end index. When pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

Source​

-

packages/extension-api/src/extension-api.d.ts:892

+

packages/extension-api/src/extension-api.d.ts:892

Methods​

validateInput()?​

@@ -110,6 +110,6 @@ to the user.

Either a human-readable string which is presented as an error message or an InputBoxValidationMessage which can provide a specific message severity. Return undefined, null, or the empty string when 'value' is valid.

Source​

-

packages/extension-api/src/extension-api.d.ts:933

+

packages/extension-api/src/extension-api.d.ts:933

\ No newline at end of file diff --git a/api/interfaces/InputBoxValidationMessage.html b/api/interfaces/InputBoxValidationMessage.html index 6b41a621006..19fadfde74c 100644 --- a/api/interfaces/InputBoxValidationMessage.html +++ b/api/interfaces/InputBoxValidationMessage.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The validation message to display.

Source​

-

packages/extension-api/src/extension-api.d.ts:862

+

packages/extension-api/src/extension-api.d.ts:862

severity​

@@ -36,6 +36,6 @@ NOTE: When using InputBoxValidationSeverity.Error, the user will not be allowed to accept (hit ENTER) the input. Info and Warning will still allow the InputBox to accept the input.

Source​

-

packages/extension-api/src/extension-api.d.ts:869

+

packages/extension-api/src/extension-api.d.ts:869

\ No newline at end of file diff --git a/api/interfaces/InstallCheck.html b/api/interfaces/InstallCheck.html index 81a512d816a..33371b99807 100644 --- a/api/interfaces/InstallCheck.html +++ b/api/interfaces/InstallCheck.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:408

+

packages/extension-api/src/extension-api.d.ts:408

Methods​

execute()​

@@ -33,7 +33,7 @@

Returns​

Promise <CheckResult>

Source​

-

packages/extension-api/src/extension-api.d.ts:409

+

packages/extension-api/src/extension-api.d.ts:409

init()?​

@@ -42,6 +42,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:410

+

packages/extension-api/src/extension-api.d.ts:410

\ No newline at end of file diff --git a/api/interfaces/KubeconfigUpdateEvent.html b/api/interfaces/KubeconfigUpdateEvent.html index 14358d0bb93..ab686cf0ad2 100644 --- a/api/interfaces/KubeconfigUpdateEvent.html +++ b/api/interfaces/KubeconfigUpdateEvent.html @@ -13,7 +13,7 @@ - + @@ -25,13 +25,13 @@

readonly location: Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1864

+

packages/extension-api/src/extension-api.d.ts:1864

type​

readonly type: "CREATE" | "UPDATE" | "DELETE"

Source​

-

packages/extension-api/src/extension-api.d.ts:1863

+

packages/extension-api/src/extension-api.d.ts:1863

\ No newline at end of file diff --git a/api/interfaces/KubernetesGeneratorProvider.html b/api/interfaces/KubernetesGeneratorProvider.html index 5ed0872e343..c47dc13f38b 100644 --- a/api/interfaces/KubernetesGeneratorProvider.html +++ b/api/interfaces/KubernetesGeneratorProvider.html @@ -13,7 +13,7 @@ - + @@ -26,14 +26,14 @@ KubernetesGeneratorType.

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1890

+

packages/extension-api/src/extension-api.d.ts:1890

types​

types: KubernetesGeneratorSelector

Source​

-

packages/extension-api/src/extension-api.d.ts:1891

+

packages/extension-api/src/extension-api.d.ts:1891

Methods​

generate()​

@@ -44,6 +44,6 @@ KubernetesGeneratorType.

Returns​

Promise <GenerateKubeResult>

Source​

-

packages/extension-api/src/extension-api.d.ts:1892

+

packages/extension-api/src/extension-api.d.ts:1892

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnection.html b/api/interfaces/KubernetesProviderConnection.html index 3f68f217ce3..be11a571f2d 100644 --- a/api/interfaces/KubernetesProviderConnection.html +++ b/api/interfaces/KubernetesProviderConnection.html @@ -13,7 +13,7 @@ - + @@ -24,21 +24,21 @@

endpoint: KubernetesProviderConnectionEndpoint

Source​

-

packages/extension-api/src/extension-api.d.ts:340

+

packages/extension-api/src/extension-api.d.ts:340

lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

packages/extension-api/src/extension-api.d.ts:341

+

packages/extension-api/src/extension-api.d.ts:341

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:339

+

packages/extension-api/src/extension-api.d.ts:339

Methods​

status()​

@@ -47,6 +47,6 @@

Returns​

ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:342

+

packages/extension-api/src/extension-api.d.ts:342

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionEndpoint.html b/api/interfaces/KubernetesProviderConnectionEndpoint.html index 5295627f609..5d2a8d399cb 100644 --- a/api/interfaces/KubernetesProviderConnectionEndpoint.html +++ b/api/interfaces/KubernetesProviderConnectionEndpoint.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

apiURL: string

Source​

-

packages/extension-api/src/extension-api.d.ts:336

+

packages/extension-api/src/extension-api.d.ts:336

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionFactory.html b/api/interfaces/KubernetesProviderConnectionFactory.html index 9307cea0df8..438860c8c0c 100644 --- a/api/interfaces/KubernetesProviderConnectionFactory.html +++ b/api/interfaces/KubernetesProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Inherited from​

ProviderConnectionFactory . creationButtonTitle

Source​

-

packages/extension-api/src/extension-api.d.ts:354

+

packages/extension-api/src/extension-api.d.ts:354

creationDisplayName?​

@@ -39,7 +39,7 @@

Inherited from​

ProviderConnectionFactory . creationDisplayName

Source​

-

packages/extension-api/src/extension-api.d.ts:351

+

packages/extension-api/src/extension-api.d.ts:351

Methods​

create()?​

@@ -52,7 +52,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:366

+

packages/extension-api/src/extension-api.d.ts:366

initialize()?​

@@ -63,6 +63,6 @@

Inherited from​

ProviderConnectionFactory . initialize

Source​

-

packages/extension-api/src/extension-api.d.ts:348

+

packages/extension-api/src/extension-api.d.ts:348

\ No newline at end of file diff --git a/api/interfaces/LifecycleContext.html b/api/interfaces/LifecycleContext.html index d19578f6e5e..364763b5ad2 100644 --- a/api/interfaces/LifecycleContext.html +++ b/api/interfaces/LifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

log: Logger

Source​

-

packages/extension-api/src/extension-api.d.ts:263

+

packages/extension-api/src/extension-api.d.ts:263

\ No newline at end of file diff --git a/api/interfaces/Link.html b/api/interfaces/Link.html index 575aa43b528..6e7007be755 100644 --- a/api/interfaces/Link.html +++ b/api/interfaces/Link.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional group: string

Source​

-

packages/extension-api/src/extension-api.d.ts:390

+

packages/extension-api/src/extension-api.d.ts:390

title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:388

+

packages/extension-api/src/extension-api.d.ts:388

url​

url: string

Source​

-

packages/extension-api/src/extension-api.d.ts:389

+

packages/extension-api/src/extension-api.d.ts:389

\ No newline at end of file diff --git a/api/interfaces/ListImagesOptions.html b/api/interfaces/ListImagesOptions.html index 55a49b9badd..4757f4052b6 100644 --- a/api/interfaces/ListImagesOptions.html +++ b/api/interfaces/ListImagesOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Default Value​

undefined

Source​

-

packages/extension-api/src/extension-api.d.ts:3081

+

packages/extension-api/src/extension-api.d.ts:3081

\ No newline at end of file diff --git a/api/interfaces/ListInfosOptions.html b/api/interfaces/ListInfosOptions.html index 78718b96cd4..33478bdd156 100644 --- a/api/interfaces/ListInfosOptions.html +++ b/api/interfaces/ListInfosOptions.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Default Value​

undefined

Source​

-

packages/extension-api/src/extension-api.d.ts:3185

+

packages/extension-api/src/extension-api.d.ts:3185

\ No newline at end of file diff --git a/api/interfaces/Logger.html b/api/interfaces/Logger.html index 000cb0d2423..677e587a7f7 100644 --- a/api/interfaces/Logger.html +++ b/api/interfaces/Logger.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:257

+

packages/extension-api/src/extension-api.d.ts:257

log()​

@@ -39,7 +39,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:255

+

packages/extension-api/src/extension-api.d.ts:255

warn()​

@@ -50,6 +50,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:259

+

packages/extension-api/src/extension-api.d.ts:259

\ No newline at end of file diff --git a/api/interfaces/ManifestCreateOptions.html b/api/interfaces/ManifestCreateOptions.html index 28f5d5fd8ce..aa252f85aa2 100644 --- a/api/interfaces/ManifestCreateOptions.html +++ b/api/interfaces/ManifestCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

optional all: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:311

+

packages/extension-api/src/extension-api.d.ts:311

amend?​

optional amend: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:310

+

packages/extension-api/src/extension-api.d.ts:310

images​

images: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:308

+

packages/extension-api/src/extension-api.d.ts:308

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:309

+

packages/extension-api/src/extension-api.d.ts:309

provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:314

+

packages/extension-api/src/extension-api.d.ts:314

\ No newline at end of file diff --git a/api/interfaces/ManifestInspectInfo.html b/api/interfaces/ManifestInspectInfo.html index 7fe265801c8..04760ba22e9 100644 --- a/api/interfaces/ManifestInspectInfo.html +++ b/api/interfaces/ManifestInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:317

+

packages/extension-api/src/extension-api.d.ts:317

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:318

+

packages/extension-api/src/extension-api.d.ts:318

manifests​

manifests: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:319

+

packages/extension-api/src/extension-api.d.ts:319

mediaType​

mediaType: string

Source​

-

packages/extension-api/src/extension-api.d.ts:331

+

packages/extension-api/src/extension-api.d.ts:331

schemaVersion​

schemaVersion: number

Source​

-

packages/extension-api/src/extension-api.d.ts:332

+

packages/extension-api/src/extension-api.d.ts:332

\ No newline at end of file diff --git a/api/interfaces/MemoryStats.html b/api/interfaces/MemoryStats.html index a9d4c05a3c1..d4413361295 100644 --- a/api/interfaces/MemoryStats.html +++ b/api/interfaces/MemoryStats.html @@ -13,7 +13,7 @@ - + @@ -24,42 +24,42 @@

optional commitbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2881

+

packages/extension-api/src/extension-api.d.ts:2881

commitpeakbytes?​

optional commitpeakbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2882

+

packages/extension-api/src/extension-api.d.ts:2882

failcnt​

failcnt: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2877

+

packages/extension-api/src/extension-api.d.ts:2877

limit​

limit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2878

+

packages/extension-api/src/extension-api.d.ts:2878

max_usage​

max_usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2875

+

packages/extension-api/src/extension-api.d.ts:2875

privateworkingset?​

optional privateworkingset: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2883

+

packages/extension-api/src/extension-api.d.ts:2883

stats​

@@ -182,13 +182,13 @@

writeback: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2844

+

packages/extension-api/src/extension-api.d.ts:2844

usage​

usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2876

+

packages/extension-api/src/extension-api.d.ts:2876

\ No newline at end of file diff --git a/api/interfaces/MenuItem.html b/api/interfaces/MenuItem.html index 3098a9cf6fe..188b178b2b5 100644 --- a/api/interfaces/MenuItem.html +++ b/api/interfaces/MenuItem.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

Should only be specified for checkbox or radio type menu items.

Source​

-

packages/extension-api/src/extension-api.d.ts:79

+

packages/extension-api/src/extension-api.d.ts:79

enabled?​

@@ -33,14 +33,14 @@

If false, the menu item will be greyed out and unclickable.

Source​

-

packages/extension-api/src/extension-api.d.ts:71

+

packages/extension-api/src/extension-api.d.ts:71

icon?​

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:67

+

packages/extension-api/src/extension-api.d.ts:67

id​

@@ -48,28 +48,28 @@

Unique within a single menu. Should be same as commandId for handler

Source​

-

packages/extension-api/src/extension-api.d.ts:62

+

packages/extension-api/src/extension-api.d.ts:62

label?​

optional label: string

Source​

-

packages/extension-api/src/extension-api.d.ts:65

+

packages/extension-api/src/extension-api.d.ts:65

optional submenu: MenuItem[]

Source​

-

packages/extension-api/src/extension-api.d.ts:81

+

packages/extension-api/src/extension-api.d.ts:81

type?​

optional type: "normal" | "separator" | "submenu" | "checkbox" | "radio"

Source​

-

packages/extension-api/src/extension-api.d.ts:64

+

packages/extension-api/src/extension-api.d.ts:64

visible?​

@@ -77,6 +77,6 @@

If false, the menu item will be entirely hidden.

Source​

-

packages/extension-api/src/extension-api.d.ts:75

+

packages/extension-api/src/extension-api.d.ts:75

\ No newline at end of file diff --git a/api/interfaces/MountSettings.html b/api/interfaces/MountSettings.html index f2332e25c70..144444c4a63 100644 --- a/api/interfaces/MountSettings.html +++ b/api/interfaces/MountSettings.html @@ -13,7 +13,7 @@ - + @@ -28,42 +28,42 @@

Propagation: MountPropagation

Source​

-

packages/extension-api/src/extension-api.d.ts:2140

+

packages/extension-api/src/extension-api.d.ts:2140

Consistency?​

optional Consistency: MountConsistency

Source​

-

packages/extension-api/src/extension-api.d.ts:2138

+

packages/extension-api/src/extension-api.d.ts:2138

Mode?​

optional Mode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2139

+

packages/extension-api/src/extension-api.d.ts:2139

ReadOnly?​

optional ReadOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2137

+

packages/extension-api/src/extension-api.d.ts:2137

Source​

Source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2135

+

packages/extension-api/src/extension-api.d.ts:2135

Target​

Target: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2134

+

packages/extension-api/src/extension-api.d.ts:2134

TmpfsOptions?​

@@ -78,14 +78,14 @@

SizeBytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2151

+

packages/extension-api/src/extension-api.d.ts:2151

Type​

Type: MountType

Source​

-

packages/extension-api/src/extension-api.d.ts:2136

+

packages/extension-api/src/extension-api.d.ts:2136

VolumeOptions?​

@@ -116,6 +116,6 @@

NoCopy: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2143

+

packages/extension-api/src/extension-api.d.ts:2143

\ No newline at end of file diff --git a/api/interfaces/NetworkContainer.html b/api/interfaces/NetworkContainer.html index ec7b195f635..01512ac7231 100644 --- a/api/interfaces/NetworkContainer.html +++ b/api/interfaces/NetworkContainer.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1990

+

packages/extension-api/src/extension-api.d.ts:1990

IPv4Address​

IPv4Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1992

+

packages/extension-api/src/extension-api.d.ts:1992

IPv6Address​

IPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1993

+

packages/extension-api/src/extension-api.d.ts:1993

MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1991

+

packages/extension-api/src/extension-api.d.ts:1991

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:1989

+

packages/extension-api/src/extension-api.d.ts:1989

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateOptions.html b/api/interfaces/NetworkCreateOptions.html index cf86535498a..3049464a0a6 100644 --- a/api/interfaces/NetworkCreateOptions.html +++ b/api/interfaces/NetworkCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3085

+

packages/extension-api/src/extension-api.d.ts:3085

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateResult.html b/api/interfaces/NetworkCreateResult.html index 6edcdcefad0..c4523c6d667 100644 --- a/api/interfaces/NetworkCreateResult.html +++ b/api/interfaces/NetworkCreateResult.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3089

+

packages/extension-api/src/extension-api.d.ts:3089

\ No newline at end of file diff --git a/api/interfaces/NetworkInfo.html b/api/interfaces/NetworkInfo.html index 694c4f600b3..b2a2a3d53f3 100644 --- a/api/interfaces/NetworkInfo.html +++ b/api/interfaces/NetworkInfo.html @@ -13,7 +13,7 @@ - + @@ -24,83 +24,83 @@

optional Aliases: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2065

+

packages/extension-api/src/extension-api.d.ts:2065

EndpointID​

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2067

+

packages/extension-api/src/extension-api.d.ts:2067

Gateway​

Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2068

+

packages/extension-api/src/extension-api.d.ts:2068

GlobalIPv6Address​

GlobalIPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2072

+

packages/extension-api/src/extension-api.d.ts:2072

GlobalIPv6PrefixLen​

GlobalIPv6PrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2073

+

packages/extension-api/src/extension-api.d.ts:2073

IPAMConfig?​

optional IPAMConfig: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2063

+

packages/extension-api/src/extension-api.d.ts:2063

IPAddress​

IPAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2069

+

packages/extension-api/src/extension-api.d.ts:2069

IPPrefixLen​

IPPrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2070

+

packages/extension-api/src/extension-api.d.ts:2070

IPv6Gateway​

IPv6Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2071

+

packages/extension-api/src/extension-api.d.ts:2071

optional Links: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2064

+

packages/extension-api/src/extension-api.d.ts:2064

MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2074

+

packages/extension-api/src/extension-api.d.ts:2074

NetworkID​

NetworkID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2066

+

packages/extension-api/src/extension-api.d.ts:2066

\ No newline at end of file diff --git a/api/interfaces/NetworkInspectInfo.html b/api/interfaces/NetworkInspectInfo.html index 6738b386917..d83bbefd424 100644 --- a/api/interfaces/NetworkInspectInfo.html +++ b/api/interfaces/NetworkInspectInfo.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

Attachable: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2014

+

packages/extension-api/src/extension-api.d.ts:2014

ConfigFrom?​

@@ -35,14 +35,14 @@

Network: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2016

+

packages/extension-api/src/extension-api.d.ts:2016

ConfigOnly​

ConfigOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2017

+

packages/extension-api/src/extension-api.d.ts:2017

Containers?​

@@ -51,56 +51,56 @@

Index signature​

[id: string]: NetworkContainer

Source​

-

packages/extension-api/src/extension-api.d.ts:2018

+

packages/extension-api/src/extension-api.d.ts:2018

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2008

+

packages/extension-api/src/extension-api.d.ts:2008

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2010

+

packages/extension-api/src/extension-api.d.ts:2010

EnableIPv6​

EnableIPv6: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2011

+

packages/extension-api/src/extension-api.d.ts:2011

IPAM?​

optional IPAM: IPAM

Source​

-

packages/extension-api/src/extension-api.d.ts:2012

+

packages/extension-api/src/extension-api.d.ts:2012

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2007

+

packages/extension-api/src/extension-api.d.ts:2007

Ingress​

Ingress: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2015

+

packages/extension-api/src/extension-api.d.ts:2015

Internal​

Internal: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2013

+

packages/extension-api/src/extension-api.d.ts:2013

Labels?​

@@ -109,14 +109,14 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2020

+

packages/extension-api/src/extension-api.d.ts:2020

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2006

+

packages/extension-api/src/extension-api.d.ts:2006

Options?​

@@ -125,34 +125,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2019

+

packages/extension-api/src/extension-api.d.ts:2019

Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2009

+

packages/extension-api/src/extension-api.d.ts:2009

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2003

+

packages/extension-api/src/extension-api.d.ts:2003

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2004

+

packages/extension-api/src/extension-api.d.ts:2004

engineType​

engineType: "docker" | "podman"

Source​

-

packages/extension-api/src/extension-api.d.ts:2005

+

packages/extension-api/src/extension-api.d.ts:2005

\ No newline at end of file diff --git a/api/interfaces/NetworkStats.html b/api/interfaces/NetworkStats.html index b3b74df61ea..a3aec15f16e 100644 --- a/api/interfaces/NetworkStats.html +++ b/api/interfaces/NetworkStats.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/NetworkingConfig.html b/api/interfaces/NetworkingConfig.html index c4138e64f9b..2f1bf75ff72 100644 --- a/api/interfaces/NetworkingConfig.html +++ b/api/interfaces/NetworkingConfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Index signature​

[key: string]: EndpointSettings

Source​

-

packages/extension-api/src/extension-api.d.ts:2574

+

packages/extension-api/src/extension-api.d.ts:2574

\ No newline at end of file diff --git a/api/interfaces/NotificationOptions.html b/api/interfaces/NotificationOptions.html index 8ca1c931226..a1d1d7c3830 100644 --- a/api/interfaces/NotificationOptions.html +++ b/api/interfaces/NotificationOptions.html @@ -13,7 +13,7 @@ - + @@ -25,7 +25,7 @@

The body text of the notification, which will be displayed below the title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1198

+

packages/extension-api/src/extension-api.d.ts:1198

highlight?​

@@ -33,7 +33,7 @@

this notification will be highlighted to the user so it draws attention

Source​

-

packages/extension-api/src/extension-api.d.ts:1214

+

packages/extension-api/src/extension-api.d.ts:1214

markdownActions?​

@@ -41,7 +41,7 @@

displayed below the description. It contains actions (like markdown commands/buttons and links)

Source​

-

packages/extension-api/src/extension-api.d.ts:1210

+

packages/extension-api/src/extension-api.d.ts:1210

silent?​

@@ -49,7 +49,7 @@

Whether or not to emit an OS notification noise when showing the notification.

Source​

-

packages/extension-api/src/extension-api.d.ts:1202

+

packages/extension-api/src/extension-api.d.ts:1202

title?​

@@ -57,7 +57,7 @@

A title for the notification, which will be shown at the top of the notification window when it is shown.

Source​

-

packages/extension-api/src/extension-api.d.ts:1194

+

packages/extension-api/src/extension-api.d.ts:1194

type?​

@@ -65,6 +65,6 @@

The type of the notification. Default value: info

Source​

-

packages/extension-api/src/extension-api.d.ts:1206

+

packages/extension-api/src/extension-api.d.ts:1206

\ No newline at end of file diff --git a/api/interfaces/OpenDialogOptions.html b/api/interfaces/OpenDialogOptions.html index affbcb2a565..16125bec75b 100644 --- a/api/interfaces/OpenDialogOptions.html +++ b/api/interfaces/OpenDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1556

+

packages/extension-api/src/extension-api.d.ts:1556

filters?​

@@ -34,7 +34,7 @@

A set of file filters that are used by the dialog.

Source​

-

packages/extension-api/src/extension-api.d.ts:1572

+

packages/extension-api/src/extension-api.d.ts:1572

openLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the open button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1561

+

packages/extension-api/src/extension-api.d.ts:1561

selectors?​

@@ -51,7 +51,7 @@

Contains which features the dialog should use. The following values are supported:

Source​

-

packages/extension-api/src/extension-api.d.ts:1567

+

packages/extension-api/src/extension-api.d.ts:1567

title?​

@@ -59,6 +59,6 @@ supported:

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1580

+

packages/extension-api/src/extension-api.d.ts:1580

\ No newline at end of file diff --git a/api/interfaces/PidsStats.html b/api/interfaces/PidsStats.html index bf20cf81c90..5525862e791 100644 --- a/api/interfaces/PidsStats.html +++ b/api/interfaces/PidsStats.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional current: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2798

+

packages/extension-api/src/extension-api.d.ts:2798

limit?​

optional limit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2799

+

packages/extension-api/src/extension-api.d.ts:2799

\ No newline at end of file diff --git a/api/interfaces/PodContainerInfo.html b/api/interfaces/PodContainerInfo.html index 51d1570fbbe..d26d83fb936 100644 --- a/api/interfaces/PodContainerInfo.html +++ b/api/interfaces/PodContainerInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2078

+

packages/extension-api/src/extension-api.d.ts:2078

Names​

Names: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2079

+

packages/extension-api/src/extension-api.d.ts:2079

Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2080

+

packages/extension-api/src/extension-api.d.ts:2080

\ No newline at end of file diff --git a/api/interfaces/PodCreateOptions.html b/api/interfaces/PodCreateOptions.html index 7337fdddb25..8ff8cfff80e 100644 --- a/api/interfaces/PodCreateOptions.html +++ b/api/interfaces/PodCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -26,27 +26,27 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:302

+

packages/extension-api/src/extension-api.d.ts:302

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:300

+

packages/extension-api/src/extension-api.d.ts:300

portmappings?​

optional portmappings: PodCreatePortOptions[]

Source​

-

packages/extension-api/src/extension-api.d.ts:301

+

packages/extension-api/src/extension-api.d.ts:301

provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:304

+

packages/extension-api/src/extension-api.d.ts:304

\ No newline at end of file diff --git a/api/interfaces/PodCreatePortOptions.html b/api/interfaces/PodCreatePortOptions.html index d1dc16bfe44..d610568114f 100644 --- a/api/interfaces/PodCreatePortOptions.html +++ b/api/interfaces/PodCreatePortOptions.html @@ -13,7 +13,7 @@ - + @@ -24,34 +24,34 @@

container_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:293

+

packages/extension-api/src/extension-api.d.ts:293

host_ip​

host_ip: string

Source​

-

packages/extension-api/src/extension-api.d.ts:292

+

packages/extension-api/src/extension-api.d.ts:292

host_port​

host_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:294

+

packages/extension-api/src/extension-api.d.ts:294

protocol​

protocol: string

Source​

-

packages/extension-api/src/extension-api.d.ts:295

+

packages/extension-api/src/extension-api.d.ts:295

range​

range: number

Source​

-

packages/extension-api/src/extension-api.d.ts:296

+

packages/extension-api/src/extension-api.d.ts:296

\ No newline at end of file diff --git a/api/interfaces/PodInfo.html b/api/interfaces/PodInfo.html index 13b809b10b8..e680997ada2 100644 --- a/api/interfaces/PodInfo.html +++ b/api/interfaces/PodInfo.html @@ -13,7 +13,7 @@ - + @@ -24,35 +24,35 @@

Cgroup: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2087

+

packages/extension-api/src/extension-api.d.ts:2087

Containers​

Containers: PodContainerInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2088

+

packages/extension-api/src/extension-api.d.ts:2088

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2089

+

packages/extension-api/src/extension-api.d.ts:2089

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2090

+

packages/extension-api/src/extension-api.d.ts:2090

InfraId​

InfraId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2091

+

packages/extension-api/src/extension-api.d.ts:2091

Labels​

@@ -61,55 +61,55 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2092

+

packages/extension-api/src/extension-api.d.ts:2092

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2093

+

packages/extension-api/src/extension-api.d.ts:2093

Namespace​

Namespace: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2094

+

packages/extension-api/src/extension-api.d.ts:2094

Networks​

Networks: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2095

+

packages/extension-api/src/extension-api.d.ts:2095

Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2096

+

packages/extension-api/src/extension-api.d.ts:2096

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2084

+

packages/extension-api/src/extension-api.d.ts:2084

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2085

+

packages/extension-api/src/extension-api.d.ts:2085

kind​

kind: "podman" | "kubernetes"

Source​

-

packages/extension-api/src/extension-api.d.ts:2086

+

packages/extension-api/src/extension-api.d.ts:2086

\ No newline at end of file diff --git a/api/interfaces/PodmanContainerCreateOptions.html b/api/interfaces/PodmanContainerCreateOptions.html index 87deac216c8..5b6ef48bdb8 100644 --- a/api/interfaces/PodmanContainerCreateOptions.html +++ b/api/interfaces/PodmanContainerCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional command: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2578

+

packages/extension-api/src/extension-api.d.ts:2578

entrypoint?​

optional entrypoint: string | string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2579

+

packages/extension-api/src/extension-api.d.ts:2579

env?​

@@ -40,41 +40,41 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2580

+

packages/extension-api/src/extension-api.d.ts:2580

hostname?​

optional hostname: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2582

+

packages/extension-api/src/extension-api.d.ts:2582

image?​

optional image: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2583

+

packages/extension-api/src/extension-api.d.ts:2583

mounts?​

optional mounts: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2585

+

packages/extension-api/src/extension-api.d.ts:2585

name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2584

+

packages/extension-api/src/extension-api.d.ts:2584

pod?​

optional pod: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2581

+

packages/extension-api/src/extension-api.d.ts:2581

\ No newline at end of file diff --git a/api/interfaces/Port.html b/api/interfaces/Port.html index 7f67cc3a403..9e7d87eecbf 100644 --- a/api/interfaces/Port.html +++ b/api/interfaces/Port.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

IP: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2056

+

packages/extension-api/src/extension-api.d.ts:2056

PrivatePort​

PrivatePort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2057

+

packages/extension-api/src/extension-api.d.ts:2057

PublicPort​

PublicPort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2058

+

packages/extension-api/src/extension-api.d.ts:2058

Type​

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2059

+

packages/extension-api/src/extension-api.d.ts:2059

\ No newline at end of file diff --git a/api/interfaces/PortBinding.html b/api/interfaces/PortBinding.html index e64324467b8..5e64c9e0712 100644 --- a/api/interfaces/PortBinding.html +++ b/api/interfaces/PortBinding.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional HostIp: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2114

+

packages/extension-api/src/extension-api.d.ts:2114

HostPort?​

optional HostPort: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2115

+

packages/extension-api/src/extension-api.d.ts:2115

\ No newline at end of file diff --git a/api/interfaces/PortMap.html b/api/interfaces/PortMap.html index 5ea2292feea..33c8b85fdaf 100644 --- a/api/interfaces/PortMap.html +++ b/api/interfaces/PortMap.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/Progress.html b/api/interfaces/Progress.html index c22045c5ca1..ac3eccdca0d 100644 --- a/api/interfaces/Progress.html +++ b/api/interfaces/Progress.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ report on how much work finished

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:765

+

packages/extension-api/src/extension-api.d.ts:765

\ No newline at end of file diff --git a/api/interfaces/ProgressOptions.html b/api/interfaces/ProgressOptions.html index 83ceb780354..fc48adbcff7 100644 --- a/api/interfaces/ProgressOptions.html +++ b/api/interfaces/ProgressOptions.html @@ -13,7 +13,7 @@ - + @@ -29,7 +29,7 @@ cancel the long running operation. Note that currently only ProgressLocation.Notification is supporting to show a cancel button.

Source​

-

packages/extension-api/src/extension-api.d.ts:809

+

packages/extension-api/src/extension-api.d.ts:809

location​

@@ -37,7 +37,7 @@ button.

The location at which progress should show.

Source​

-

packages/extension-api/src/extension-api.d.ts:795

+

packages/extension-api/src/extension-api.d.ts:795

title?​

@@ -46,6 +46,6 @@ button.

A human-readable string which will be used to describe the operation.

Source​

-

packages/extension-api/src/extension-api.d.ts:801

+

packages/extension-api/src/extension-api.d.ts:801

\ No newline at end of file diff --git a/api/interfaces/Provider.html b/api/interfaces/Provider.html index 67520a74b1b..84b2a66a95f 100644 --- a/api/interfaces/Provider.html +++ b/api/interfaces/Provider.html @@ -13,7 +13,7 @@ - + @@ -24,77 +24,77 @@

readonly detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:505

+

packages/extension-api/src/extension-api.d.ts:505

id​

readonly id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:490

+

packages/extension-api/src/extension-api.d.ts:490

images​

readonly images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:500

+

packages/extension-api/src/extension-api.d.ts:500

readonly links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:502

+

packages/extension-api/src/extension-api.d.ts:502

name​

readonly name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:489

+

packages/extension-api/src/extension-api.d.ts:489

onDidUpdateDetectionChecks​

onDidUpdateDetectionChecks: Event <ProviderDetectionCheck[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:516

+

packages/extension-api/src/extension-api.d.ts:516

onDidUpdateStatus​

onDidUpdateStatus: Event <ProviderStatus>

Source​

-

packages/extension-api/src/extension-api.d.ts:493

+

packages/extension-api/src/extension-api.d.ts:493

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Source​

-

packages/extension-api/src/extension-api.d.ts:498

+

packages/extension-api/src/extension-api.d.ts:498

status​

readonly status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:491

+

packages/extension-api/src/extension-api.d.ts:491

version​

readonly version: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:496

+

packages/extension-api/src/extension-api.d.ts:496

warnings​

readonly warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:512

+

packages/extension-api/src/extension-api.d.ts:512

Methods​

dispose()​

@@ -103,7 +103,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:488

+

packages/extension-api/src/extension-api.d.ts:488

registerAutostart()​

@@ -114,7 +114,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:484

+

packages/extension-api/src/extension-api.d.ts:484

registerCleanup()​

@@ -125,7 +125,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:486

+

packages/extension-api/src/extension-api.d.ts:486

registerContainerProviderConnection()​

@@ -136,7 +136,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:473

+

packages/extension-api/src/extension-api.d.ts:473

registerInstallation()​

@@ -147,7 +147,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:478

+

packages/extension-api/src/extension-api.d.ts:478

registerKubernetesProviderConnection()​

@@ -158,7 +158,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:474

+

packages/extension-api/src/extension-api.d.ts:474

registerLifecycle()​

@@ -169,7 +169,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:475

+

packages/extension-api/src/extension-api.d.ts:475

registerUpdate()​

@@ -180,7 +180,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:481

+

packages/extension-api/src/extension-api.d.ts:481

setContainerProviderConnectionFactory()​

@@ -192,7 +192,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:464

+

packages/extension-api/src/extension-api.d.ts:464

setKubernetesProviderConnectionFactory()​

@@ -204,7 +204,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:468

+

packages/extension-api/src/extension-api.d.ts:468

updateDetectionChecks()​

@@ -215,7 +215,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:509

+

packages/extension-api/src/extension-api.d.ts:509

updateStatus()​

@@ -226,7 +226,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:492

+

packages/extension-api/src/extension-api.d.ts:492

updateVersion()​

@@ -237,7 +237,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:497

+

packages/extension-api/src/extension-api.d.ts:497

updateWarnings()​

@@ -248,6 +248,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:513

+

packages/extension-api/src/extension-api.d.ts:513

\ No newline at end of file diff --git a/api/interfaces/ProviderAutostart.html b/api/interfaces/ProviderAutostart.html index 88a674d0364..64934ddaad0 100644 --- a/api/interfaces/ProviderAutostart.html +++ b/api/interfaces/ProviderAutostart.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@ It can be turned off/on by the user.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:433

+

packages/extension-api/src/extension-api.d.ts:433

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanup.html b/api/interfaces/ProviderCleanup.html index 91cfa1eb044..6968caa471d 100644 --- a/api/interfaces/ProviderCleanup.html +++ b/api/interfaces/ProviderCleanup.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise <ProviderCleanupAction[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:440

+

packages/extension-api/src/extension-api.d.ts:440

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupAction.html b/api/interfaces/ProviderCleanupAction.html index fe8f4cdd664..25f65b58e72 100644 --- a/api/interfaces/ProviderCleanupAction.html +++ b/api/interfaces/ProviderCleanupAction.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:451

+

packages/extension-api/src/extension-api.d.ts:451

Methods​

execute()​

@@ -35,6 +35,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:453

+

packages/extension-api/src/extension-api.d.ts:453

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupExecuteOptions.html b/api/interfaces/ProviderCleanupExecuteOptions.html index c656f296ce1..4ea8ce3e4b8 100644 --- a/api/interfaces/ProviderCleanupExecuteOptions.html +++ b/api/interfaces/ProviderCleanupExecuteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

logger: Logger

Source​

-

packages/extension-api/src/extension-api.d.ts:444

+

packages/extension-api/src/extension-api.d.ts:444

token?​

optional token: CancellationToken

Source​

-

packages/extension-api/src/extension-api.d.ts:445

+

packages/extension-api/src/extension-api.d.ts:445

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionFactory.html b/api/interfaces/ProviderConnectionFactory.html index 6fb0e25c16b..8c60f52ab20 100644 --- a/api/interfaces/ProviderConnectionFactory.html +++ b/api/interfaces/ProviderConnectionFactory.html @@ -13,7 +13,7 @@ - + @@ -29,14 +29,14 @@

optional creationButtonTitle: string

Source​

-

packages/extension-api/src/extension-api.d.ts:354

+

packages/extension-api/src/extension-api.d.ts:354

creationDisplayName?​

optional creationDisplayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:351

+

packages/extension-api/src/extension-api.d.ts:351

Methods​

initialize()?​

@@ -45,6 +45,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:348

+

packages/extension-api/src/extension-api.d.ts:348

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionLifecycle.html b/api/interfaces/ProviderConnectionLifecycle.html index ebc9230e75d..78fb773df2d 100644 --- a/api/interfaces/ProviderConnectionLifecycle.html +++ b/api/interfaces/ProviderConnectionLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:269

+

packages/extension-api/src/extension-api.d.ts:269

edit()?​

@@ -42,7 +42,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:270

+

packages/extension-api/src/extension-api.d.ts:270

start()?​

@@ -54,7 +54,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:267

+

packages/extension-api/src/extension-api.d.ts:267

stop()?​

@@ -66,6 +66,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:268

+

packages/extension-api/src/extension-api.d.ts:268

\ No newline at end of file diff --git a/api/interfaces/ProviderContainerConnection.html b/api/interfaces/ProviderContainerConnection.html index 04b57183563..26f83ed49f1 100644 --- a/api/interfaces/ProviderContainerConnection.html +++ b/api/interfaces/ProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:578

+

packages/extension-api/src/extension-api.d.ts:578

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:577

+

packages/extension-api/src/extension-api.d.ts:577

\ No newline at end of file diff --git a/api/interfaces/ProviderDetectionCheck.html b/api/interfaces/ProviderDetectionCheck.html index 408d52ecb1b..e5d99233b10 100644 --- a/api/interfaces/ProviderDetectionCheck.html +++ b/api/interfaces/ProviderDetectionCheck.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional details: string

Source​

-

packages/extension-api/src/extension-api.d.ts:231

+

packages/extension-api/src/extension-api.d.ts:231

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:230

+

packages/extension-api/src/extension-api.d.ts:230

status​

status: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:232

+

packages/extension-api/src/extension-api.d.ts:232

\ No newline at end of file diff --git a/api/interfaces/ProviderEvent.html b/api/interfaces/ProviderEvent.html index 44455f17c2e..241d59910db 100644 --- a/api/interfaces/ProviderEvent.html +++ b/api/interfaces/ProviderEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:546

+

packages/extension-api/src/extension-api.d.ts:546

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:547

+

packages/extension-api/src/extension-api.d.ts:547

status​

status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:548

+

packages/extension-api/src/extension-api.d.ts:548

\ No newline at end of file diff --git a/api/interfaces/ProviderImages.html b/api/interfaces/ProviderImages.html index 837fd620fc1..eea9142391b 100644 --- a/api/interfaces/ProviderImages.html +++ b/api/interfaces/ProviderImages.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional icon: string | object

Source​

-

packages/extension-api/src/extension-api.d.ts:459

+

packages/extension-api/src/extension-api.d.ts:459

optional logo: string | object

Source​

-

packages/extension-api/src/extension-api.d.ts:460

+

packages/extension-api/src/extension-api.d.ts:460

\ No newline at end of file diff --git a/api/interfaces/ProviderInformation.html b/api/interfaces/ProviderInformation.html index 986afe59afd..da4c565bd08 100644 --- a/api/interfaces/ProviderInformation.html +++ b/api/interfaces/ProviderInformation.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

optional details: string

Source​

-

packages/extension-api/src/extension-api.d.ts:226

+

packages/extension-api/src/extension-api.d.ts:226

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:225

+

packages/extension-api/src/extension-api.d.ts:225

\ No newline at end of file diff --git a/api/interfaces/ProviderInstallation.html b/api/interfaces/ProviderInstallation.html index 2402efdf221..7de6158bc0e 100644 --- a/api/interfaces/ProviderInstallation.html +++ b/api/interfaces/ProviderInstallation.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:416

+

packages/extension-api/src/extension-api.d.ts:416

preflightChecks()?​

@@ -37,6 +37,6 @@

Returns​

InstallCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:414

+

packages/extension-api/src/extension-api.d.ts:414

\ No newline at end of file diff --git a/api/interfaces/ProviderLifecycle.html b/api/interfaces/ProviderLifecycle.html index 67cac9ad1e1..c8af4a46320 100644 --- a/api/interfaces/ProviderLifecycle.html +++ b/api/interfaces/ProviderLifecycle.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:216

+

packages/extension-api/src/extension-api.d.ts:216

start()​

@@ -39,7 +39,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:217

+

packages/extension-api/src/extension-api.d.ts:217

status()​

@@ -48,7 +48,7 @@

Returns​

ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:219

+

packages/extension-api/src/extension-api.d.ts:219

stop()​

@@ -59,6 +59,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:218

+

packages/extension-api/src/extension-api.d.ts:218

\ No newline at end of file diff --git a/api/interfaces/ProviderOptions.html b/api/interfaces/ProviderOptions.html index bf0baec52a5..b933806d1c0 100644 --- a/api/interfaces/ProviderOptions.html +++ b/api/interfaces/ProviderOptions.html @@ -13,7 +13,7 @@ - + @@ -24,62 +24,62 @@

optional detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:242

+

packages/extension-api/src/extension-api.d.ts:242

emptyConnectionMarkdownDescription?​

optional emptyConnectionMarkdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:248

+

packages/extension-api/src/extension-api.d.ts:248

id​

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:236

+

packages/extension-api/src/extension-api.d.ts:236

images?​

optional images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:240

+

packages/extension-api/src/extension-api.d.ts:240

optional links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:241

+

packages/extension-api/src/extension-api.d.ts:241

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:237

+

packages/extension-api/src/extension-api.d.ts:237

status​

status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:238

+

packages/extension-api/src/extension-api.d.ts:238

version?​

optional version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:239

+

packages/extension-api/src/extension-api.d.ts:239

warnings?​

optional warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:245

+

packages/extension-api/src/extension-api.d.ts:245

\ No newline at end of file diff --git a/api/interfaces/ProviderUpdate.html b/api/interfaces/ProviderUpdate.html index f21251c2952..242656f1a31 100644 --- a/api/interfaces/ProviderUpdate.html +++ b/api/interfaces/ProviderUpdate.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:420

+

packages/extension-api/src/extension-api.d.ts:420

Methods​

preflightChecks()?​

@@ -33,7 +33,7 @@

Returns​

InstallCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:424

+

packages/extension-api/src/extension-api.d.ts:424

update()​

@@ -44,6 +44,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:422

+

packages/extension-api/src/extension-api.d.ts:422

\ No newline at end of file diff --git a/api/interfaces/ProxySettings.html b/api/interfaces/ProxySettings.html index 02de95fd543..d47a1e5077f 100644 --- a/api/interfaces/ProxySettings.html +++ b/api/interfaces/ProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

httpProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:605

+

packages/extension-api/src/extension-api.d.ts:605

httpsProxy​

httpsProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:606

+

packages/extension-api/src/extension-api.d.ts:606

noProxy​

noProxy: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:607

+

packages/extension-api/src/extension-api.d.ts:607

\ No newline at end of file diff --git a/api/interfaces/PullEvent.html b/api/interfaces/PullEvent.html index 11025030f34..d6ad48c3c4d 100644 --- a/api/interfaces/PullEvent.html +++ b/api/interfaces/PullEvent.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

optional error: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2428

+

packages/extension-api/src/extension-api.d.ts:2428

errorDetails?​

@@ -35,21 +35,21 @@

optional message: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2429

+

packages/extension-api/src/extension-api.d.ts:2429

id?​

optional id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2421

+

packages/extension-api/src/extension-api.d.ts:2421

progress?​

optional progress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2423

+

packages/extension-api/src/extension-api.d.ts:2423

progressDetail?​

@@ -64,20 +64,20 @@

optional total: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2424

+

packages/extension-api/src/extension-api.d.ts:2424

status?​

optional status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2422

+

packages/extension-api/src/extension-api.d.ts:2422

stream?​

optional stream: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2420

+

packages/extension-api/src/extension-api.d.ts:2420

\ No newline at end of file diff --git a/api/interfaces/QuickInputButton.html b/api/interfaces/QuickInputButton.html index 5d898110b59..49d5ee05751 100644 --- a/api/interfaces/QuickInputButton.html +++ b/api/interfaces/QuickInputButton.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Icon for the button.

Source​

-

packages/extension-api/src/extension-api.d.ts:965

+

packages/extension-api/src/extension-api.d.ts:965

tooltip?​

@@ -34,6 +34,6 @@

An optional tooltip.

Source​

-

packages/extension-api/src/extension-api.d.ts:970

+

packages/extension-api/src/extension-api.d.ts:970

\ No newline at end of file diff --git a/api/interfaces/QuickPickItem.html b/api/interfaces/QuickPickItem.html index d96c48863e3..e8696f1b519 100644 --- a/api/interfaces/QuickPickItem.html +++ b/api/interfaces/QuickPickItem.html @@ -13,7 +13,7 @@ - + @@ -28,7 +28,7 @@ a list of items.

Always show this item.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1066

+

packages/extension-api/src/extension-api.d.ts:1066

buttons?​

@@ -40,7 +40,7 @@ created by the window.createQuickPick createQuickPick() API. Buttons are not ren the showQuickPick() API.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1076

+

packages/extension-api/src/extension-api.d.ts:1076

description?​

@@ -50,7 +50,7 @@ the showQuickPick() ThemeIcon theme icons via the $(<name>)-syntax.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1038

+

packages/extension-api/src/extension-api.d.ts:1038

detail?​

@@ -60,7 +60,7 @@ ThemeIcon theme icons via the $(<name>)-syntax.

ThemeIcon theme icons via the $(<name>)-syntax.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1046

+

packages/extension-api/src/extension-api.d.ts:1046

kind?​

@@ -69,7 +69,7 @@ ThemeIcon theme icons via the $(<name>)-syntax.

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is QuickPickItemKind.Default.

Source​

-

packages/extension-api/src/extension-api.d.ts:1030

+

packages/extension-api/src/extension-api.d.ts:1030

label​

@@ -78,7 +78,7 @@ the default is QuickPickIt

A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via the $(<name>)-syntax.

Source​

-

packages/extension-api/src/extension-api.d.ts:1024

+

packages/extension-api/src/extension-api.d.ts:1024

picked?​

@@ -93,6 +93,6 @@ to the items you want picked initially.

QuickPickOptions.canPickMany

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

Source​

-

packages/extension-api/src/extension-api.d.ts:1059

+

packages/extension-api/src/extension-api.d.ts:1059

\ No newline at end of file diff --git a/api/interfaces/QuickPickOptions.html b/api/interfaces/QuickPickOptions.html index 6cd0dbc7952..8a307e32128 100644 --- a/api/interfaces/QuickPickOptions.html +++ b/api/interfaces/QuickPickOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

An optional flag to make the picker accept multiple selections, if true the result is an array of picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:1006

+

packages/extension-api/src/extension-api.d.ts:1006

ignoreFocusOut?​

@@ -35,7 +35,7 @@

Set to true to keep the picker open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

Source​

-

packages/extension-api/src/extension-api.d.ts:1001

+

packages/extension-api/src/extension-api.d.ts:1001

matchOnDescription?​

@@ -43,7 +43,7 @@ This setting is ignored on iPad and is always false.

An optional flag to include the description when filtering the picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:985

+

packages/extension-api/src/extension-api.d.ts:985

matchOnDetail?​

@@ -51,7 +51,7 @@ This setting is ignored on iPad and is always false.

An optional flag to include the detail when filtering the picks.

Source​

-

packages/extension-api/src/extension-api.d.ts:990

+

packages/extension-api/src/extension-api.d.ts:990

placeHolder?​

@@ -59,7 +59,7 @@ This setting is ignored on iPad and is always false.

An optional string to show as placeholder in the input box to guide the user what to pick on.

Source​

-

packages/extension-api/src/extension-api.d.ts:995

+

packages/extension-api/src/extension-api.d.ts:995

title?​

@@ -67,7 +67,7 @@ This setting is ignored on iPad and is always false.

An optional string that represents the title of the quick pick.

Source​

-

packages/extension-api/src/extension-api.d.ts:980

+

packages/extension-api/src/extension-api.d.ts:980

Methods​

onDidSelectItem()?​

@@ -79,6 +79,6 @@ This setting is ignored on iPad and is always false.

Returns​

any

Source​

-

packages/extension-api/src/extension-api.d.ts:1012

+

packages/extension-api/src/extension-api.d.ts:1012

\ No newline at end of file diff --git a/api/interfaces/RegisterContainerConnectionEvent.html b/api/interfaces/RegisterContainerConnectionEvent.html index 3f0db281ae9..12147658313 100644 --- a/api/interfaces/RegisterContainerConnectionEvent.html +++ b/api/interfaces/RegisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:574

+

packages/extension-api/src/extension-api.d.ts:574

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:573

+

packages/extension-api/src/extension-api.d.ts:573

\ No newline at end of file diff --git a/api/interfaces/RegisterKubernetesConnectionEvent.html b/api/interfaces/RegisterKubernetesConnectionEvent.html index 9e6aec52c24..7ce2503d491 100644 --- a/api/interfaces/RegisterKubernetesConnectionEvent.html +++ b/api/interfaces/RegisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:570

+

packages/extension-api/src/extension-api.d.ts:570

\ No newline at end of file diff --git a/api/interfaces/Registry.html b/api/interfaces/Registry.html index 58f702ef814..879bb910a1f 100644 --- a/api/interfaces/Registry.html +++ b/api/interfaces/Registry.html @@ -13,7 +13,7 @@ - + @@ -30,14 +30,14 @@

Inherited from​

RegistryCreateOptions . alias

Source​

-

packages/extension-api/src/extension-api.d.ts:645

+

packages/extension-api/src/extension-api.d.ts:645

icon?​

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:637

+

packages/extension-api/src/extension-api.d.ts:637

insecure?​

@@ -46,14 +46,14 @@

Inherited from​

RegistryCreateOptions . insecure

Source​

-

packages/extension-api/src/extension-api.d.ts:644

+

packages/extension-api/src/extension-api.d.ts:644

name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:636

+

packages/extension-api/src/extension-api.d.ts:636

secret​

@@ -62,7 +62,7 @@

Inherited from​

RegistryCreateOptions . secret

Source​

-

packages/extension-api/src/extension-api.d.ts:643

+

packages/extension-api/src/extension-api.d.ts:643

serverUrl​

@@ -71,14 +71,14 @@

Inherited from​

RegistryCreateOptions . serverUrl

Source​

-

packages/extension-api/src/extension-api.d.ts:641

+

packages/extension-api/src/extension-api.d.ts:641

source​

source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:633

+

packages/extension-api/src/extension-api.d.ts:633

username​

@@ -87,6 +87,6 @@

Inherited from​

RegistryCreateOptions . username

Source​

-

packages/extension-api/src/extension-api.d.ts:642

+

packages/extension-api/src/extension-api.d.ts:642

\ No newline at end of file diff --git a/api/interfaces/RegistryConfig.html b/api/interfaces/RegistryConfig.html index 24640fb4c6c..e89a5acd61d 100644 --- a/api/interfaces/RegistryConfig.html +++ b/api/interfaces/RegistryConfig.html @@ -13,7 +13,7 @@ - + diff --git a/api/interfaces/RegistryCreateOptions.html b/api/interfaces/RegistryCreateOptions.html index 3f94338a6b7..02491678222 100644 --- a/api/interfaces/RegistryCreateOptions.html +++ b/api/interfaces/RegistryCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -28,34 +28,34 @@

optional alias: string

Source​

-

packages/extension-api/src/extension-api.d.ts:645

+

packages/extension-api/src/extension-api.d.ts:645

insecure?​

optional insecure: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:644

+

packages/extension-api/src/extension-api.d.ts:644

secret​

secret: string

Source​

-

packages/extension-api/src/extension-api.d.ts:643

+

packages/extension-api/src/extension-api.d.ts:643

serverUrl​

serverUrl: string

Source​

-

packages/extension-api/src/extension-api.d.ts:641

+

packages/extension-api/src/extension-api.d.ts:641

username​

username: string

Source​

-

packages/extension-api/src/extension-api.d.ts:642

+

packages/extension-api/src/extension-api.d.ts:642

\ No newline at end of file diff --git a/api/interfaces/RegistryProvider.html b/api/interfaces/RegistryProvider.html index 4ada290b65b..92f4e3f1f6a 100644 --- a/api/interfaces/RegistryProvider.html +++ b/api/interfaces/RegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@

readonly name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:649

+

packages/extension-api/src/extension-api.d.ts:649

Methods​

create()​

@@ -35,6 +35,6 @@

Returns​

Registry

Source​

-

packages/extension-api/src/extension-api.d.ts:650

+

packages/extension-api/src/extension-api.d.ts:650

\ No newline at end of file diff --git a/api/interfaces/RegistrySuggestedProvider.html b/api/interfaces/RegistrySuggestedProvider.html index 5d889be6e72..62b8d73f4d3 100644 --- a/api/interfaces/RegistrySuggestedProvider.html +++ b/api/interfaces/RegistrySuggestedProvider.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:629

+

packages/extension-api/src/extension-api.d.ts:629

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:625

+

packages/extension-api/src/extension-api.d.ts:625

url​

url: string

Source​

-

packages/extension-api/src/extension-api.d.ts:626

+

packages/extension-api/src/extension-api.d.ts:626

\ No newline at end of file diff --git a/api/interfaces/RunError.html b/api/interfaces/RunError.html index def7b3ee97e..87806a1021e 100644 --- a/api/interfaces/RunError.html +++ b/api/interfaces/RunError.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@

Indicates whether the execution was cancelled.

Source​

-

packages/extension-api/src/extension-api.d.ts:3847

+

packages/extension-api/src/extension-api.d.ts:3847

cause?​

@@ -47,7 +47,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3832

+

packages/extension-api/src/extension-api.d.ts:3832

exitCode​

@@ -55,7 +55,7 @@

The exit code of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3827

+

packages/extension-api/src/extension-api.d.ts:3827

killed​

@@ -63,7 +63,7 @@

Indicates whether the process was forcefully killed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3852

+

packages/extension-api/src/extension-api.d.ts:3852

message​

@@ -73,7 +73,7 @@

Overrides​

Error.message

Source​

-

packages/extension-api/src/extension-api.d.ts:3822

+

packages/extension-api/src/extension-api.d.ts:3822

name​

@@ -99,7 +99,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3842

+

packages/extension-api/src/extension-api.d.ts:3842

stdout​

@@ -107,6 +107,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3837

+

packages/extension-api/src/extension-api.d.ts:3837

\ No newline at end of file diff --git a/api/interfaces/RunOptions.html b/api/interfaces/RunOptions.html index 9ad1537bb59..7cabcf28e33 100644 --- a/api/interfaces/RunOptions.html +++ b/api/interfaces/RunOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

custom directory

Source​

-

packages/extension-api/src/extension-api.d.ts:3782

+

packages/extension-api/src/extension-api.d.ts:3782

encoding?​

@@ -34,7 +34,7 @@

The encoding to use. Default utf8

Source​

-

packages/extension-api/src/extension-api.d.ts:3792

+

packages/extension-api/src/extension-api.d.ts:3792

env?​

@@ -44,7 +44,7 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3767

+

packages/extension-api/src/extension-api.d.ts:3767

isAdmin?​

@@ -52,7 +52,7 @@

admin privileges required

Source​

-

packages/extension-api/src/extension-api.d.ts:3787

+

packages/extension-api/src/extension-api.d.ts:3787

logger?​

@@ -60,7 +60,7 @@

A logger used to track execution events.

Source​

-

packages/extension-api/src/extension-api.d.ts:3777

+

packages/extension-api/src/extension-api.d.ts:3777

token?​

@@ -68,6 +68,6 @@

A cancellation token used to request cancellation.

Source​

-

packages/extension-api/src/extension-api.d.ts:3772

+

packages/extension-api/src/extension-api.d.ts:3772

\ No newline at end of file diff --git a/api/interfaces/RunResult.html b/api/interfaces/RunResult.html index e03c93afe0c..b4c1ca4ccb1 100644 --- a/api/interfaces/RunResult.html +++ b/api/interfaces/RunResult.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3802

+

packages/extension-api/src/extension-api.d.ts:3802

stderr​

@@ -34,7 +34,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3812

+

packages/extension-api/src/extension-api.d.ts:3812

stdout​

@@ -42,6 +42,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3807

+

packages/extension-api/src/extension-api.d.ts:3807

\ No newline at end of file diff --git a/api/interfaces/SaveDialogOptions.html b/api/interfaces/SaveDialogOptions.html index b6b0b7c8859..167e405a95f 100644 --- a/api/interfaces/SaveDialogOptions.html +++ b/api/interfaces/SaveDialogOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1590

+

packages/extension-api/src/extension-api.d.ts:1590

filters?​

@@ -34,7 +34,7 @@

A set of file filters that are used by the dialog.

Source​

-

packages/extension-api/src/extension-api.d.ts:1600

+

packages/extension-api/src/extension-api.d.ts:1600

saveLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the save button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1595

+

packages/extension-api/src/extension-api.d.ts:1595

title?​

@@ -50,6 +50,6 @@

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1608

+

packages/extension-api/src/extension-api.d.ts:1608

\ No newline at end of file diff --git a/api/interfaces/SecretStorage.html b/api/interfaces/SecretStorage.html index a6f9feb1c0d..cb6b5b8a34d 100644 --- a/api/interfaces/SecretStorage.html +++ b/api/interfaces/SecretStorage.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ sensitive.

Fires when a secret is stored or deleted.

Source​

-

packages/extension-api/src/extension-api.d.ts:4272

+

packages/extension-api/src/extension-api.d.ts:4272

Methods​

delete()​

@@ -40,7 +40,7 @@ sensitive.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4267

+

packages/extension-api/src/extension-api.d.ts:4267

get()​

@@ -55,7 +55,7 @@ is no secret matching that key.

Promise<undefined | string>

The stored value or undefined.

Source​

-

packages/extension-api/src/extension-api.d.ts:4254

+

packages/extension-api/src/extension-api.d.ts:4254

store()​

@@ -70,6 +70,6 @@ is no secret matching that key.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4261

+

packages/extension-api/src/extension-api.d.ts:4261

\ No newline at end of file diff --git a/api/interfaces/SecretStorageChangeEvent.html b/api/interfaces/SecretStorageChangeEvent.html index f118f9f2454..0ec34f9255f 100644 --- a/api/interfaces/SecretStorageChangeEvent.html +++ b/api/interfaces/SecretStorageChangeEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

The key of the secret that has changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:4240

+

packages/extension-api/src/extension-api.d.ts:4240

\ No newline at end of file diff --git a/api/interfaces/StatusBarItem.html b/api/interfaces/StatusBarItem.html index 5d4966ad059..d94cbbb440e 100644 --- a/api/interfaces/StatusBarItem.html +++ b/api/interfaces/StatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -27,7 +27,7 @@ show text and icons and run a command on click.

The alignment of this item.

Source​

-

packages/extension-api/src/extension-api.d.ts:1243

+

packages/extension-api/src/extension-api.d.ts:1243

command?​

@@ -35,7 +35,7 @@ show text and icons and run a command on click.

The identifier of a command, previously registered with commands.registerCommand, to run on click.

Source​

-

packages/extension-api/src/extension-api.d.ts:1271

+

packages/extension-api/src/extension-api.d.ts:1271

commandArgs?​

@@ -43,7 +43,7 @@ show text and icons and run a command on click.

Arguments that the command handler should be invoked with.

Source​

-

packages/extension-api/src/extension-api.d.ts:1276

+

packages/extension-api/src/extension-api.d.ts:1276

enabled​

@@ -52,7 +52,7 @@ show text and icons and run a command on click.

Marks an item as disabled. When property is set to true, then icon will be changed to inactive and there won't be possible to execute a command if it is provided in the following configuration.

Source​

-

packages/extension-api/src/extension-api.d.ts:1267

+

packages/extension-api/src/extension-api.d.ts:1267

iconClass?​

@@ -62,7 +62,7 @@ and there won't be possible to execute a command if it is provided in the f Icon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons for state which can be enabled or disabled.

Source​

-

packages/extension-api/src/extension-api.d.ts:1262

+

packages/extension-api/src/extension-api.d.ts:1262

priority​

@@ -71,7 +71,7 @@ for state which can be enabled or disabled.

The priority of this item. Higher value means the item should be shown more to the left or more to the right.

Source​

-

packages/extension-api/src/extension-api.d.ts:1248

+

packages/extension-api/src/extension-api.d.ts:1248

text?​

@@ -79,7 +79,7 @@ or more to the right.

The text to show for the entry.

Source​

-

packages/extension-api/src/extension-api.d.ts:1252

+

packages/extension-api/src/extension-api.d.ts:1252

tooltip?​

@@ -87,7 +87,7 @@ or more to the right.

The tooltip text when you hover over this entry.

Source​

-

packages/extension-api/src/extension-api.d.ts:1256

+

packages/extension-api/src/extension-api.d.ts:1256

Methods​

dispose()​

@@ -98,7 +98,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1290

+

packages/extension-api/src/extension-api.d.ts:1290

hide()​

@@ -108,7 +108,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1284

+

packages/extension-api/src/extension-api.d.ts:1284

show()​

@@ -118,6 +118,6 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1280

+

packages/extension-api/src/extension-api.d.ts:1280

\ No newline at end of file diff --git a/api/interfaces/StorageStats.html b/api/interfaces/StorageStats.html index 75be3fd6232..78aea4b20f0 100644 --- a/api/interfaces/StorageStats.html +++ b/api/interfaces/StorageStats.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

optional read_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2821

+

packages/extension-api/src/extension-api.d.ts:2821

read_size_bytes?​

optional read_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2822

+

packages/extension-api/src/extension-api.d.ts:2822

write_count_normalized?​

optional write_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2823

+

packages/extension-api/src/extension-api.d.ts:2823

write_size_bytes?​

optional write_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2824

+

packages/extension-api/src/extension-api.d.ts:2824

\ No newline at end of file diff --git a/api/interfaces/TelemetryLogger.html b/api/interfaces/TelemetryLogger.html index 89cfe856da3..082d3ac3341 100644 --- a/api/interfaces/TelemetryLogger.html +++ b/api/interfaces/TelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -35,7 +35,7 @@ to forward unhandled errors to the respective extensions.

Whether or not error telemetry is enabled for this logger.

Source​

-

packages/extension-api/src/extension-api.d.ts:3909

+

packages/extension-api/src/extension-api.d.ts:3909

isUsageEnabled​

@@ -43,7 +43,7 @@ to forward unhandled errors to the respective extensions.

Whether or not usage telemetry is enabled for this logger.

Source​

-

packages/extension-api/src/extension-api.d.ts:3904

+

packages/extension-api/src/extension-api.d.ts:3904

onDidChangeEnableStates​

@@ -51,7 +51,7 @@ to forward unhandled errors to the respective extensions.

An Event which fires when the enablement state of usage or error telemetry changes.

Source​

-

packages/extension-api/src/extension-api.d.ts:3899

+

packages/extension-api/src/extension-api.d.ts:3899

Methods​

dispose()​

@@ -61,7 +61,7 @@ to forward unhandled errors to the respective extensions.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3944

+

packages/extension-api/src/extension-api.d.ts:3944

logError()​

logError(eventName, data)​

@@ -79,7 +79,7 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​
-

packages/extension-api/src/extension-api.d.ts:3931

+

packages/extension-api/src/extension-api.d.ts:3931

logError(error, data)​

logError(error, data?): void

@@ -93,7 +93,7 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​
-

packages/extension-api/src/extension-api.d.ts:3939

+

packages/extension-api/src/extension-api.d.ts:3939

logUsage()​

@@ -110,6 +110,6 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3920

+

packages/extension-api/src/extension-api.d.ts:3920

\ No newline at end of file diff --git a/api/interfaces/TelemetryLoggerOptions.html b/api/interfaces/TelemetryLoggerOptions.html index 64606b0a6f3..3a064bad593 100644 --- a/api/interfaces/TelemetryLoggerOptions.html +++ b/api/interfaces/TelemetryLoggerOptions.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Any additional common properties which should be injected into the data object.

Source​

-

packages/extension-api/src/extension-api.d.ts:3997

+

packages/extension-api/src/extension-api.d.ts:3997

ignoreBuiltInCommonProperties?​

@@ -35,7 +35,7 @@

Whether or not you want to avoid having the built-in common properties such as os, extension name, etc injected into the data object. Defaults to false if not defined.

Source​

-

packages/extension-api/src/extension-api.d.ts:3985

+

packages/extension-api/src/extension-api.d.ts:3985

ignoreUnhandledErrors?​

@@ -44,6 +44,6 @@ Defaults to false if not defined.

Whether or not unhandled errors on the extension host caused by your extension should be logged to your sender. Defaults to false if not defined.

Source​

-

packages/extension-api/src/extension-api.d.ts:3991

+

packages/extension-api/src/extension-api.d.ts:3991

\ No newline at end of file diff --git a/api/interfaces/TelemetrySender.html b/api/interfaces/TelemetrySender.html index b4643aed259..7e58d24c732 100644 --- a/api/interfaces/TelemetrySender.html +++ b/api/interfaces/TelemetrySender.html @@ -13,7 +13,7 @@ - + @@ -30,7 +30,7 @@ as its TelemetryLogger is being di

Returns​

void | Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3974

+

packages/extension-api/src/extension-api.d.ts:3974

sendErrorData()​

@@ -45,7 +45,7 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3968

+

packages/extension-api/src/extension-api.d.ts:3968

sendEventData()​

@@ -60,6 +60,6 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:3959

+

packages/extension-api/src/extension-api.d.ts:3959

\ No newline at end of file diff --git a/api/interfaces/ThrottlingData.html b/api/interfaces/ThrottlingData.html index 9bc9ae91e93..b7c82a03a3d 100644 --- a/api/interfaces/ThrottlingData.html +++ b/api/interfaces/ThrottlingData.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

periods: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2894

+

packages/extension-api/src/extension-api.d.ts:2894

throttled_periods​

throttled_periods: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2895

+

packages/extension-api/src/extension-api.d.ts:2895

throttled_time​

throttled_time: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2896

+

packages/extension-api/src/extension-api.d.ts:2896

\ No newline at end of file diff --git a/api/interfaces/UnregisterContainerConnectionEvent.html b/api/interfaces/UnregisterContainerConnectionEvent.html index 213166acc2e..54c3912613c 100644 --- a/api/interfaces/UnregisterContainerConnectionEvent.html +++ b/api/interfaces/UnregisterContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:564

+

packages/extension-api/src/extension-api.d.ts:564

\ No newline at end of file diff --git a/api/interfaces/UnregisterKubernetesConnectionEvent.html b/api/interfaces/UnregisterKubernetesConnectionEvent.html index 635623b5993..8dc52b50dc6 100644 --- a/api/interfaces/UnregisterKubernetesConnectionEvent.html +++ b/api/interfaces/UnregisterKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:567

+

packages/extension-api/src/extension-api.d.ts:567

\ No newline at end of file diff --git a/api/interfaces/UpdateContainerConnectionEvent.html b/api/interfaces/UpdateContainerConnectionEvent.html index dd9e4a4e2d5..b5b38fee82f 100644 --- a/api/interfaces/UpdateContainerConnectionEvent.html +++ b/api/interfaces/UpdateContainerConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:553

+

packages/extension-api/src/extension-api.d.ts:553

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:552

+

packages/extension-api/src/extension-api.d.ts:552

status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:554

+

packages/extension-api/src/extension-api.d.ts:554

\ No newline at end of file diff --git a/api/interfaces/UpdateKubernetesConnectionEvent.html b/api/interfaces/UpdateKubernetesConnectionEvent.html index 59af5481ae1..f64c9d91091 100644 --- a/api/interfaces/UpdateKubernetesConnectionEvent.html +++ b/api/interfaces/UpdateKubernetesConnectionEvent.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

connection: KubernetesProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:559

+

packages/extension-api/src/extension-api.d.ts:559

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:558

+

packages/extension-api/src/extension-api.d.ts:558

status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:560

+

packages/extension-api/src/extension-api.d.ts:560

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateOptions.html b/api/interfaces/VolumeCreateOptions.html index 68bacc6cabb..871231bfbe9 100644 --- a/api/interfaces/VolumeCreateOptions.html +++ b/api/interfaces/VolumeCreateOptions.html @@ -13,7 +13,7 @@ - + @@ -24,13 +24,13 @@

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3159

+

packages/extension-api/src/extension-api.d.ts:3159

provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:3161

+

packages/extension-api/src/extension-api.d.ts:3161

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateResponseInfo.html b/api/interfaces/VolumeCreateResponseInfo.html index 0c151e29593..2ee7049ebd5 100644 --- a/api/interfaces/VolumeCreateResponseInfo.html +++ b/api/interfaces/VolumeCreateResponseInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

optional CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3173

+

packages/extension-api/src/extension-api.d.ts:3173

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3171

+

packages/extension-api/src/extension-api.d.ts:3171

Labels​

@@ -40,28 +40,28 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3175

+

packages/extension-api/src/extension-api.d.ts:3175

Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3172

+

packages/extension-api/src/extension-api.d.ts:3172

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3170

+

packages/extension-api/src/extension-api.d.ts:3170

Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3176

+

packages/extension-api/src/extension-api.d.ts:3176

Status?​

@@ -70,6 +70,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3174

+

packages/extension-api/src/extension-api.d.ts:3174

\ No newline at end of file diff --git a/api/interfaces/VolumeDeleteOptions.html b/api/interfaces/VolumeDeleteOptions.html index 8ec4dd8b668..026be9e815d 100644 --- a/api/interfaces/VolumeDeleteOptions.html +++ b/api/interfaces/VolumeDeleteOptions.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:3166

+

packages/extension-api/src/extension-api.d.ts:3166

\ No newline at end of file diff --git a/api/interfaces/VolumeInfo.html b/api/interfaces/VolumeInfo.html index 98c67bea336..d2411b20e16 100644 --- a/api/interfaces/VolumeInfo.html +++ b/api/interfaces/VolumeInfo.html @@ -13,7 +13,7 @@ - + @@ -24,14 +24,14 @@

CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3137

+

packages/extension-api/src/extension-api.d.ts:3137

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3140

+

packages/extension-api/src/extension-api.d.ts:3140

Labels​

@@ -40,35 +40,35 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3143

+

packages/extension-api/src/extension-api.d.ts:3143

Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3141

+

packages/extension-api/src/extension-api.d.ts:3141

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3139

+

packages/extension-api/src/extension-api.d.ts:3139

Options?​

optional Options: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3145

+

packages/extension-api/src/extension-api.d.ts:3145

Scope​

Scope: "global" | "local"

Source​

-

packages/extension-api/src/extension-api.d.ts:3144

+

packages/extension-api/src/extension-api.d.ts:3144

Status?​

@@ -77,34 +77,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3142

+

packages/extension-api/src/extension-api.d.ts:3142

UsageData?​

optional UsageData: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3146

+

packages/extension-api/src/extension-api.d.ts:3146

containersUsage​

containersUsage: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3138

+

packages/extension-api/src/extension-api.d.ts:3138

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3135

+

packages/extension-api/src/extension-api.d.ts:3135

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3136

+

packages/extension-api/src/extension-api.d.ts:3136

\ No newline at end of file diff --git a/api/interfaces/VolumeListInfo.html b/api/interfaces/VolumeListInfo.html index 70917e3f884..f60828844a3 100644 --- a/api/interfaces/VolumeListInfo.html +++ b/api/interfaces/VolumeListInfo.html @@ -13,7 +13,7 @@ - + @@ -24,27 +24,27 @@

Volumes: VolumeInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3152

+

packages/extension-api/src/extension-api.d.ts:3152

Warnings​

Warnings: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3153

+

packages/extension-api/src/extension-api.d.ts:3153

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3154

+

packages/extension-api/src/extension-api.d.ts:3154

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3155

+

packages/extension-api/src/extension-api.d.ts:3155

\ No newline at end of file diff --git a/api/interfaces/Webview.html b/api/interfaces/Webview.html index 8ab3051f69c..2e752b1e58a 100644 --- a/api/interfaces/Webview.html +++ b/api/interfaces/Webview.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Content security policy source for webview resources.

Source​

-

packages/extension-api/src/extension-api.d.ts:1470

+

packages/extension-api/src/extension-api.d.ts:1470

html​

@@ -35,7 +35,7 @@

HTML contents of the webview.

This should be a complete, valid html document. Changing this property causes the webview to be reloaded.

Source​

-

packages/extension-api/src/extension-api.d.ts:1447

+

packages/extension-api/src/extension-api.d.ts:1447

onDidReceiveMessage​

@@ -44,7 +44,7 @@

Fired when the webview content posts a message.

Webview content can post strings or json serializable objects back to an extension.

Source​

-

packages/extension-api/src/extension-api.d.ts:1454

+

packages/extension-api/src/extension-api.d.ts:1454

options​

@@ -52,7 +52,7 @@

Content settings for the webview.

Source​

-

packages/extension-api/src/extension-api.d.ts:1439

+

packages/extension-api/src/extension-api.d.ts:1439

Methods​

asWebviewUri()​

@@ -64,7 +64,7 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1464

+

packages/extension-api/src/extension-api.d.ts:1464

postMessage()​

@@ -76,6 +76,6 @@

Returns​

Promise<boolean>

Source​

-

packages/extension-api/src/extension-api.d.ts:1459

+

packages/extension-api/src/extension-api.d.ts:1459

\ No newline at end of file diff --git a/api/interfaces/WebviewInfo.html b/api/interfaces/WebviewInfo.html index 30464568a4f..c50fb97fc59 100644 --- a/api/interfaces/WebviewInfo.html +++ b/api/interfaces/WebviewInfo.html @@ -13,7 +13,7 @@ - + @@ -24,20 +24,20 @@

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2792

+

packages/extension-api/src/extension-api.d.ts:2792

title​

title: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2794

+

packages/extension-api/src/extension-api.d.ts:2794

viewType​

viewType: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2793

+

packages/extension-api/src/extension-api.d.ts:2793

\ No newline at end of file diff --git a/api/interfaces/WebviewOptions.html b/api/interfaces/WebviewOptions.html index 5be59eea322..c02d5853e3c 100644 --- a/api/interfaces/WebviewOptions.html +++ b/api/interfaces/WebviewOptions.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Default to the root folders of the current workspace plus the extension's install directory.

Pass in an empty array to disallow access to any local resources.

Source​

-

packages/extension-api/src/extension-api.d.ts:1429

+

packages/extension-api/src/extension-api.d.ts:1429

\ No newline at end of file diff --git a/api/interfaces/WebviewPanel.html b/api/interfaces/WebviewPanel.html index c2b591f1c90..5e273e9772f 100644 --- a/api/interfaces/WebviewPanel.html +++ b/api/interfaces/WebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -26,7 +26,7 @@

Whether the panel is active (focused by the user).

Source​

-

packages/extension-api/src/extension-api.d.ts:1511

+

packages/extension-api/src/extension-api.d.ts:1511

iconPath?​

@@ -34,7 +34,7 @@

Icon for the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1490

+

packages/extension-api/src/extension-api.d.ts:1490

onDidChangeViewState​

@@ -42,7 +42,7 @@

Fired when the panel's view state changes.

Source​

-

packages/extension-api/src/extension-api.d.ts:1521

+

packages/extension-api/src/extension-api.d.ts:1521

onDidDispose​

@@ -53,7 +53,7 @@ called on it.

Trying to use the panel after it has been disposed throws an exception.

Source​

-

packages/extension-api/src/extension-api.d.ts:1531

+

packages/extension-api/src/extension-api.d.ts:1531

title​

@@ -61,7 +61,7 @@ called on it.

Title of the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1485

+

packages/extension-api/src/extension-api.d.ts:1485

viewType​

@@ -69,7 +69,7 @@ called on it.

Identifies the type of the webview panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1480

+

packages/extension-api/src/extension-api.d.ts:1480

visible​

@@ -77,7 +77,7 @@ called on it.

Whether the panel is visible.

Source​

-

packages/extension-api/src/extension-api.d.ts:1516

+

packages/extension-api/src/extension-api.d.ts:1516

webview​

@@ -85,7 +85,7 @@ called on it.

Webview belonging to the panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1506

+

packages/extension-api/src/extension-api.d.ts:1506

Methods​

dispose()​

@@ -98,7 +98,7 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1546

+

packages/extension-api/src/extension-api.d.ts:1546

reveal()​

@@ -111,6 +111,6 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1537

+

packages/extension-api/src/extension-api.d.ts:1537

\ No newline at end of file diff --git a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html index 45963844423..be2d7e4a7d7 100644 --- a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html +++ b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Webview panel whose view state changed.

Source​

-

packages/extension-api/src/extension-api.d.ts:1618

+

packages/extension-api/src/extension-api.d.ts:1618

\ No newline at end of file diff --git a/api/namespaces/authentication.html b/api/namespaces/authentication.html index d6fdd7eac60..67a4431e354 100644 --- a/api/namespaces/authentication.html +++ b/api/namespaces/authentication.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/authentication/functions/getSession.html b/api/namespaces/authentication/functions/getSession.html index 8c77bec1d18..cfb09387a23 100644 --- a/api/namespaces/authentication/functions/getSession.html +++ b/api/namespaces/authentication/functions/getSession.html @@ -13,7 +13,7 @@ - + @@ -39,7 +39,7 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&

Promise <AuthenticationSession | undefined>

A promise that resolves to an authentication session

Source​

-

packages/extension-api/src/extension-api.d.ts:3646

+

packages/extension-api/src/extension-api.d.ts:3646

getSession(providerId, scopes, options)​

getSession(providerId, scopes, options?): Promise <AuthenticationSession | undefined>

@@ -61,6 +61,6 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&

Promise <AuthenticationSession | undefined>

A promise that resolves to an authentication session if available, or undefined if there are no sessions

Source​

-

packages/extension-api/src/extension-api.d.ts:3665

+

packages/extension-api/src/extension-api.d.ts:3665

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/onDidChangeSessions.html b/api/namespaces/authentication/functions/onDidChangeSessions.html index afef3a8a5a8..9d730db710b 100644 --- a/api/namespaces/authentication/functions/onDidChangeSessions.html +++ b/api/namespaces/authentication/functions/onDidChangeSessions.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ been added, removed, or changed.

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:3675

+

packages/extension-api/src/extension-api.d.ts:3675

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/registerAuthenticationProvider.html b/api/namespaces/authentication/functions/registerAuthenticationProvider.html index 6ebc9d75247..437ad8e0bfc 100644 --- a/api/namespaces/authentication/functions/registerAuthenticationProvider.html +++ b/api/namespaces/authentication/functions/registerAuthenticationProvider.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@ has already been used by another provider. Ids are case-sensitive.

Params​

options Additional options for the provider.

Source​

-

packages/extension-api/src/extension-api.d.ts:3689

+

packages/extension-api/src/extension-api.d.ts:3689

\ No newline at end of file diff --git a/api/namespaces/cli.html b/api/namespaces/cli.html index d363d874a02..4557c87d284 100644 --- a/api/namespaces/cli.html +++ b/api/namespaces/cli.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/cli/functions/createCliTool.html b/api/namespaces/cli/functions/createCliTool.html index 9c9ca6a6a2b..3072cd5dccd 100644 --- a/api/namespaces/cli/functions/createCliTool.html +++ b/api/namespaces/cli/functions/createCliTool.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

CliTool

CliTool instance

Source​

-

packages/extension-api/src/extension-api.d.ts:4104

+

packages/extension-api/src/extension-api.d.ts:4104

\ No newline at end of file diff --git a/api/namespaces/commands.html b/api/namespaces/commands.html index cddf14e4561..10196495d89 100644 --- a/api/namespaces/commands.html +++ b/api/namespaces/commands.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/commands/functions/executeCommand.html b/api/namespaces/commands/functions/executeCommand.html index f930e004657..ee253f023c0 100644 --- a/api/namespaces/commands/functions/executeCommand.html +++ b/api/namespaces/commands/functions/executeCommand.html @@ -13,7 +13,7 @@ - + @@ -38,6 +38,6 @@

Throws​

if the command throws an exception

Source​

-

packages/extension-api/src/extension-api.d.ts:542

+

packages/extension-api/src/extension-api.d.ts:542

\ No newline at end of file diff --git a/api/namespaces/commands/functions/registerCommand.html b/api/namespaces/commands/functions/registerCommand.html index 3caced702b8..2750fdf0f5d 100644 --- a/api/namespaces/commands/functions/registerCommand.html +++ b/api/namespaces/commands/functions/registerCommand.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Throws​

if a command with the same name is already registered.

Source​

-

packages/extension-api/src/extension-api.d.ts:530

+

packages/extension-api/src/extension-api.d.ts:530

\ No newline at end of file diff --git a/api/namespaces/configuration.html b/api/namespaces/configuration.html index a87e0b85b15..a6058638b90 100644 --- a/api/namespaces/configuration.html +++ b/api/namespaces/configuration.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/configuration/functions/getConfiguration.html b/api/namespaces/configuration/functions/getConfiguration.html index f02fcc2e26f..89115a852a6 100644 --- a/api/namespaces/configuration/functions/getConfiguration.html +++ b/api/namespaces/configuration/functions/getConfiguration.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Configuration

Source​

-

packages/extension-api/src/extension-api.d.ts:689

+

packages/extension-api/src/extension-api.d.ts:689

\ No newline at end of file diff --git a/api/namespaces/configuration/functions/onDidChangeConfiguration.html b/api/namespaces/configuration/functions/onDidChangeConfiguration.html index 16a1f1eff03..1fdd4472ed1 100644 --- a/api/namespaces/configuration/functions/onDidChangeConfiguration.html +++ b/api/namespaces/configuration/functions/onDidChangeConfiguration.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:694

+

packages/extension-api/src/extension-api.d.ts:694

\ No newline at end of file diff --git a/api/namespaces/containerEngine.html b/api/namespaces/containerEngine.html index 444879c3e0b..799e02123d2 100644 --- a/api/namespaces/containerEngine.html +++ b/api/namespaces/containerEngine.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/containerEngine/functions/buildImage.html b/api/namespaces/containerEngine/functions/buildImage.html index e2c49b98cec..5b43f749989 100644 --- a/api/namespaces/containerEngine/functions/buildImage.html +++ b/api/namespaces/containerEngine/functions/buildImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise<unknown>

Source​

-

packages/extension-api/src/extension-api.d.ts:3290

+

packages/extension-api/src/extension-api.d.ts:3290

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createContainer.html b/api/namespaces/containerEngine/functions/createContainer.html index d1339d2b47c..5b2a78ac5f2 100644 --- a/api/namespaces/containerEngine/functions/createContainer.html +++ b/api/namespaces/containerEngine/functions/createContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise <ContainerCreateResult>

A promise resolving to the information on the created container

Source​

-

packages/extension-api/src/extension-api.d.ts:3215

+

packages/extension-api/src/extension-api.d.ts:3215

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createManifest.html b/api/namespaces/containerEngine/functions/createManifest.html index d86abc03aba..26d2558521f 100644 --- a/api/namespaces/containerEngine/functions/createManifest.html +++ b/api/namespaces/containerEngine/functions/createManifest.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3425

+

packages/extension-api/src/extension-api.d.ts:3425

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createNetwork.html b/api/namespaces/containerEngine/functions/createNetwork.html index f79642824ba..4d89d91428f 100644 --- a/api/namespaces/containerEngine/functions/createNetwork.html +++ b/api/namespaces/containerEngine/functions/createNetwork.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise <NetworkCreateResult>

Source​

-

packages/extension-api/src/extension-api.d.ts:3404

+

packages/extension-api/src/extension-api.d.ts:3404

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createPod.html b/api/namespaces/containerEngine/functions/createPod.html index cac7f23d29f..ad2b4d4c70c 100644 --- a/api/namespaces/containerEngine/functions/createPod.html +++ b/api/namespaces/containerEngine/functions/createPod.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3413

+

packages/extension-api/src/extension-api.d.ts:3413

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createVolume.html b/api/namespaces/containerEngine/functions/createVolume.html index 8af7f03d72a..964efb4d2d8 100644 --- a/api/namespaces/containerEngine/functions/createVolume.html +++ b/api/namespaces/containerEngine/functions/createVolume.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise <VolumeCreateResponseInfo>

Source​

-

packages/extension-api/src/extension-api.d.ts:3410

+

packages/extension-api/src/extension-api.d.ts:3410

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteContainer.html b/api/namespaces/containerEngine/functions/deleteContainer.html index 585b1f200cc..7ddb3b5b0f7 100644 --- a/api/namespaces/containerEngine/functions/deleteContainer.html +++ b/api/namespaces/containerEngine/functions/deleteContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3282

+

packages/extension-api/src/extension-api.d.ts:3282

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteImage.html b/api/namespaces/containerEngine/functions/deleteImage.html index 3986824b6ff..b8930a14f51 100644 --- a/api/namespaces/containerEngine/functions/deleteImage.html +++ b/api/namespaces/containerEngine/functions/deleteImage.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3370

+

packages/extension-api/src/extension-api.d.ts:3370

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteVolume.html b/api/namespaces/containerEngine/functions/deleteVolume.html index 978b4ccb27e..54c18fb4323 100644 --- a/api/namespaces/containerEngine/functions/deleteVolume.html +++ b/api/namespaces/containerEngine/functions/deleteVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3411

+

packages/extension-api/src/extension-api.d.ts:3411

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/getImageInspect.html b/api/namespaces/containerEngine/functions/getImageInspect.html index b356330b1ec..c1100761b31 100644 --- a/api/namespaces/containerEngine/functions/getImageInspect.html +++ b/api/namespaces/containerEngine/functions/getImageInspect.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise <ImageInspectInfo>

A promise resolving to a structure containing the image information

Source​

-

packages/extension-api/src/extension-api.d.ts:3379

+

packages/extension-api/src/extension-api.d.ts:3379

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/info.html b/api/namespaces/containerEngine/functions/info.html index 065ca6da517..9ddf6af5a90 100644 --- a/api/namespaces/containerEngine/functions/info.html +++ b/api/namespaces/containerEngine/functions/info.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise <ContainerEngineInfo>

Source​

-

packages/extension-api/src/extension-api.d.ts:3381

+

packages/extension-api/src/extension-api.d.ts:3381

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectContainer.html b/api/namespaces/containerEngine/functions/inspectContainer.html index 0ce5f3ff41d..9fd908bd14e 100644 --- a/api/namespaces/containerEngine/functions/inspectContainer.html +++ b/api/namespaces/containerEngine/functions/inspectContainer.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

Promise <ContainerInspectInfo>

A promise resolving to a structure containing the container information

Source​

-

packages/extension-api/src/extension-api.d.ts:3206

+

packages/extension-api/src/extension-api.d.ts:3206

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectManifest.html b/api/namespaces/containerEngine/functions/inspectManifest.html index 44c3044d6b6..419697c7484 100644 --- a/api/namespaces/containerEngine/functions/inspectManifest.html +++ b/api/namespaces/containerEngine/functions/inspectManifest.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise <ManifestInspectInfo>

Source​

-

packages/extension-api/src/extension-api.d.ts:3426

+

packages/extension-api/src/extension-api.d.ts:3426

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listContainers.html b/api/namespaces/containerEngine/functions/listContainers.html index ceea0143f5d..3fc2b1ae938 100644 --- a/api/namespaces/containerEngine/functions/listContainers.html +++ b/api/namespaces/containerEngine/functions/listContainers.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Promise <ContainerInfo[]>

A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the containerEngine.inspectContainer method.

Source​

-

packages/extension-api/src/extension-api.d.ts:3197

+

packages/extension-api/src/extension-api.d.ts:3197

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listImages.html b/api/namespaces/containerEngine/functions/listImages.html index 4eba5122657..50c94111bdc 100644 --- a/api/namespaces/containerEngine/functions/listImages.html +++ b/api/namespaces/containerEngine/functions/listImages.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ 
// Example 1: List all container images when no specific provider is provided.
const images = await listImages();
console.log(images);
// Example 2: List container images for a specific provider.
const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
const images = await listImages({ provider: provider.connection });
console.log(images);

Source​

-

packages/extension-api/src/extension-api.d.ts:3322

+

packages/extension-api/src/extension-api.d.ts:3322

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listInfos.html b/api/namespaces/containerEngine/functions/listInfos.html index 8a3b95229aa..37e83617006 100644 --- a/api/namespaces/containerEngine/functions/listInfos.html +++ b/api/namespaces/containerEngine/functions/listInfos.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ 
// Example 1: List all engine information when no specific provider is provided.
const infos = await listInfos();
console.log(infos);
// Example 2: List information for a specific provider.
const provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');
const info = await listInfos({ provider: provider.connection });
console.log(info);

Source​

-

packages/extension-api/src/extension-api.d.ts:3400

+

packages/extension-api/src/extension-api.d.ts:3400

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listNetworks.html b/api/namespaces/containerEngine/functions/listNetworks.html index 63d60c81222..2c877dfb029 100644 --- a/api/namespaces/containerEngine/functions/listNetworks.html +++ b/api/namespaces/containerEngine/functions/listNetworks.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise <NetworkInspectInfo[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:3403

+

packages/extension-api/src/extension-api.d.ts:3403

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listPods.html b/api/namespaces/containerEngine/functions/listPods.html index 2ece079de6f..a560fef69fd 100644 --- a/api/namespaces/containerEngine/functions/listPods.html +++ b/api/namespaces/containerEngine/functions/listPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise <PodInfo[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:3420

+

packages/extension-api/src/extension-api.d.ts:3420

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listVolumes.html b/api/namespaces/containerEngine/functions/listVolumes.html index 63d47016dce..72921b57e98 100644 --- a/api/namespaces/containerEngine/functions/listVolumes.html +++ b/api/namespaces/containerEngine/functions/listVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise <VolumeListInfo[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:3409

+

packages/extension-api/src/extension-api.d.ts:3409

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/logsContainer.html b/api/namespaces/containerEngine/functions/logsContainer.html index 75b759dff61..db11a8892d4 100644 --- a/api/namespaces/containerEngine/functions/logsContainer.html +++ b/api/namespaces/containerEngine/functions/logsContainer.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3235

+

packages/extension-api/src/extension-api.d.ts:3235

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/onEvent.html b/api/namespaces/containerEngine/functions/onEvent.html index ad81d76fdc4..8be67808b30 100644 --- a/api/namespaces/containerEngine/functions/onEvent.html +++ b/api/namespaces/containerEngine/functions/onEvent.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:3401

+

packages/extension-api/src/extension-api.d.ts:3401

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pullImage.html b/api/namespaces/containerEngine/functions/pullImage.html index 8b1ad71601a..fa8aa1e009a 100644 --- a/api/namespaces/containerEngine/functions/pullImage.html +++ b/api/namespaces/containerEngine/functions/pullImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3358

+

packages/extension-api/src/extension-api.d.ts:3358

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushImage.html b/api/namespaces/containerEngine/functions/pushImage.html index 10717805a4b..c5581745ff3 100644 --- a/api/namespaces/containerEngine/functions/pushImage.html +++ b/api/namespaces/containerEngine/functions/pushImage.html @@ -13,7 +13,7 @@ - + @@ -35,6 +35,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3344

+

packages/extension-api/src/extension-api.d.ts:3344

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removePod.html b/api/namespaces/containerEngine/functions/removePod.html index e1ba7976f3c..103ad4faf40 100644 --- a/api/namespaces/containerEngine/functions/removePod.html +++ b/api/namespaces/containerEngine/functions/removePod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3422

+

packages/extension-api/src/extension-api.d.ts:3422

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html index 2d6c84a9cfe..c4443671ab6 100644 --- a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html +++ b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html @@ -13,7 +13,7 @@ - + @@ -39,6 +39,6 @@

Warnings: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3414

+

packages/extension-api/src/extension-api.d.ts:3414

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/saveImage.html b/api/namespaces/containerEngine/functions/saveImage.html index 21b5efd1726..548420beee4 100644 --- a/api/namespaces/containerEngine/functions/saveImage.html +++ b/api/namespaces/containerEngine/functions/saveImage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3303

+

packages/extension-api/src/extension-api.d.ts:3303

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startContainer.html b/api/namespaces/containerEngine/functions/startContainer.html index eced0dab758..dda10185625 100644 --- a/api/namespaces/containerEngine/functions/startContainer.html +++ b/api/namespaces/containerEngine/functions/startContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3226

+

packages/extension-api/src/extension-api.d.ts:3226

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startPod.html b/api/namespaces/containerEngine/functions/startPod.html index 7e710837eb7..5a5716ef01b 100644 --- a/api/namespaces/containerEngine/functions/startPod.html +++ b/api/namespaces/containerEngine/functions/startPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3419

+

packages/extension-api/src/extension-api.d.ts:3419

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/statsContainer.html b/api/namespaces/containerEngine/functions/statsContainer.html index b3098d394d5..917a4862b62 100644 --- a/api/namespaces/containerEngine/functions/statsContainer.html +++ b/api/namespaces/containerEngine/functions/statsContainer.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@

Here is a usage example

const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {
 console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);
});

// When no longer needed
disposable.dispose();

Source​

-

packages/extension-api/src/extension-api.d.ts:3261

+

packages/extension-api/src/extension-api.d.ts:3261

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopContainer.html b/api/namespaces/containerEngine/functions/stopContainer.html index 44e4257e7a1..1462d749e67 100644 --- a/api/namespaces/containerEngine/functions/stopContainer.html +++ b/api/namespaces/containerEngine/functions/stopContainer.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3273

+

packages/extension-api/src/extension-api.d.ts:3273

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopPod.html b/api/namespaces/containerEngine/functions/stopPod.html index 6e7ad5704ec..feed52bd914 100644 --- a/api/namespaces/containerEngine/functions/stopPod.html +++ b/api/namespaces/containerEngine/functions/stopPod.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3421

+

packages/extension-api/src/extension-api.d.ts:3421

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/tagImage.html b/api/namespaces/containerEngine/functions/tagImage.html index acd094f6045..ac813547a1f 100644 --- a/api/namespaces/containerEngine/functions/tagImage.html +++ b/api/namespaces/containerEngine/functions/tagImage.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:3332

+

packages/extension-api/src/extension-api.d.ts:3332

\ No newline at end of file diff --git a/api/namespaces/context.html b/api/namespaces/context.html index 1b6367b9296..718e776d119 100644 --- a/api/namespaces/context.html +++ b/api/namespaces/context.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/context/functions/setValue.html b/api/namespaces/context/functions/setValue.html index 7e753373749..420246188d7 100644 --- a/api/namespaces/context/functions/setValue.html +++ b/api/namespaces/context/functions/setValue.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ The key should consists of '"extension-id"."actual-key"

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:4031

+

packages/extension-api/src/extension-api.d.ts:4031

\ No newline at end of file diff --git a/api/namespaces/env.html b/api/namespaces/env.html index fbdcdbf57a7..25595387b25 100644 --- a/api/namespaces/env.html +++ b/api/namespaces/env.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/env/functions/createTelemetryLogger.html b/api/namespaces/env/functions/createTelemetryLogger.html index a87686088fa..81d942c7474 100644 --- a/api/namespaces/env/functions/createTelemetryLogger.html +++ b/api/namespaces/env/functions/createTelemetryLogger.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

TelemetryLogger

A new telemetry logger

Source​

-

packages/extension-api/src/extension-api.d.ts:3752

+

packages/extension-api/src/extension-api.d.ts:3752

\ No newline at end of file diff --git a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html index ac16c38ed20..188b60fc02a 100644 --- a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html +++ b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:3735

+

packages/extension-api/src/extension-api.d.ts:3735

\ No newline at end of file diff --git a/api/namespaces/env/functions/openExternal.html b/api/namespaces/env/functions/openExternal.html index dacfd11d391..87af320c29a 100644 --- a/api/namespaces/env/functions/openExternal.html +++ b/api/namespaces/env/functions/openExternal.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Promise<boolean>

A promise indicating if open was successful.

Source​

-

packages/extension-api/src/extension-api.d.ts:3743

+

packages/extension-api/src/extension-api.d.ts:3743

\ No newline at end of file diff --git a/api/namespaces/env/variables/clipboard.html b/api/namespaces/env/variables/clipboard.html index 757867e09c3..74227cc7aeb 100644 --- a/api/namespaces/env/variables/clipboard.html +++ b/api/namespaces/env/variables/clipboard.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

The system clipboard.

Source​

-

packages/extension-api/src/extension-api.d.ts:3757

+

packages/extension-api/src/extension-api.d.ts:3757

\ No newline at end of file diff --git a/api/namespaces/env/variables/isLinux.html b/api/namespaces/env/variables/isLinux.html index 901e204a11a..8fa0fb4c778 100644 --- a/api/namespaces/env/variables/isLinux.html +++ b/api/namespaces/env/variables/isLinux.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is Linux. If the value is false, it means the current system is not Linux.

Source​

-

packages/extension-api/src/extension-api.d.ts:3723

+

packages/extension-api/src/extension-api.d.ts:3723

\ No newline at end of file diff --git a/api/namespaces/env/variables/isMac.html b/api/namespaces/env/variables/isMac.html index 82ce08658ae..bf6f01e43d5 100644 --- a/api/namespaces/env/variables/isMac.html +++ b/api/namespaces/env/variables/isMac.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is macOS. If the value is false, it means the current system is not macOS.

Source​

-

packages/extension-api/src/extension-api.d.ts:3707

+

packages/extension-api/src/extension-api.d.ts:3707

\ No newline at end of file diff --git a/api/namespaces/env/variables/isTelemetryEnabled.html b/api/namespaces/env/variables/isTelemetryEnabled.html index b77ee898bfa..d0c6f47f702 100644 --- a/api/namespaces/env/variables/isTelemetryEnabled.html +++ b/api/namespaces/env/variables/isTelemetryEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Indicates whether the users has telemetry enabled. Can be observed to determine if the extension should send telemetry.

Source​

-

packages/extension-api/src/extension-api.d.ts:3729

+

packages/extension-api/src/extension-api.d.ts:3729

\ No newline at end of file diff --git a/api/namespaces/env/variables/isWindows.html b/api/namespaces/env/variables/isWindows.html index c3e7f43874f..10de8e753c1 100644 --- a/api/namespaces/env/variables/isWindows.html +++ b/api/namespaces/env/variables/isWindows.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

If the value of this flag is true, it means the current system is Windows. If the value is false, it means the current system is not Windows.

Source​

-

packages/extension-api/src/extension-api.d.ts:3715

+

packages/extension-api/src/extension-api.d.ts:3715

\ No newline at end of file diff --git a/api/namespaces/fs.html b/api/namespaces/fs.html index 8f6d0e43d83..d10d717069c 100644 --- a/api/namespaces/fs.html +++ b/api/namespaces/fs.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/fs/functions/createFileSystemWatcher.html b/api/namespaces/fs/functions/createFileSystemWatcher.html index 3ed960e8da0..a3e811bd5f4 100644 --- a/api/namespaces/fs/functions/createFileSystemWatcher.html +++ b/api/namespaces/fs/functions/createFileSystemWatcher.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

FileSystemWatcher

Source​

-

packages/extension-api/src/extension-api.d.ts:1415

+

packages/extension-api/src/extension-api.d.ts:1415

\ No newline at end of file diff --git a/api/namespaces/imageChecker.html b/api/namespaces/imageChecker.html index a0608959dc8..bde9b8e2608 100644 --- a/api/namespaces/imageChecker.html +++ b/api/namespaces/imageChecker.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html index 1effdda9587..c080f0bd1b9 100644 --- a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html +++ b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@ application can call the provider with specific tasks when necessary.

Disposable

A disposable that unregisters this provider when being disposed

Source​

-

packages/extension-api/src/extension-api.d.ts:4174

+

packages/extension-api/src/extension-api.d.ts:4174

\ No newline at end of file diff --git a/api/namespaces/kubernetes.html b/api/namespaces/kubernetes.html index 5c5f7b9106d..e5b5d0f67f7 100644 --- a/api/namespaces/kubernetes.html +++ b/api/namespaces/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/kubernetes/functions/createResources.html b/api/namespaces/kubernetes/functions/createResources.html index 53e0af157f1..48c7e905157 100644 --- a/api/namespaces/kubernetes/functions/createResources.html +++ b/api/namespaces/kubernetes/functions/createResources.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:1850

+

packages/extension-api/src/extension-api.d.ts:1850

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/getKubeconfig.html b/api/namespaces/kubernetes/functions/getKubeconfig.html index ee014de2133..1255b07d9cf 100644 --- a/api/namespaces/kubernetes/functions/getKubeconfig.html +++ b/api/namespaces/kubernetes/functions/getKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1840

+

packages/extension-api/src/extension-api.d.ts:1840

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html index b6824871dc1..a0a64e1f572 100644 --- a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html +++ b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

Disposable

A disposable which unsubscribes the event listener.

Source​

-

packages/extension-api/src/extension-api.d.ts:1841

+

packages/extension-api/src/extension-api.d.ts:1841

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html index 0aaf89f376b..8600360e639 100644 --- a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html +++ b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:1857

+

packages/extension-api/src/extension-api.d.ts:1857

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/setKubeconfig.html b/api/namespaces/kubernetes/functions/setKubeconfig.html index 1d793ae4ef7..b8a21832f79 100644 --- a/api/namespaces/kubernetes/functions/setKubeconfig.html +++ b/api/namespaces/kubernetes/functions/setKubeconfig.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:1842

+

packages/extension-api/src/extension-api.d.ts:1842

\ No newline at end of file diff --git a/api/namespaces/navigation.html b/api/namespaces/navigation.html index bd7a2eda204..c47cc58343f 100644 --- a/api/namespaces/navigation.html +++ b/api/namespaces/navigation.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/navigation/functions/navigateToAuthentication.html b/api/namespaces/navigation/functions/navigateToAuthentication.html index f57fd6cfd28..78fbc5439f0 100644 --- a/api/namespaces/navigation/functions/navigateToAuthentication.html +++ b/api/namespaces/navigation/functions/navigateToAuthentication.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4221

+

packages/extension-api/src/extension-api.d.ts:4221

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainer.html b/api/namespaces/navigation/functions/navigateToContainer.html index 9746a1aec81..a0414e4fa30 100644 --- a/api/namespaces/navigation/functions/navigateToContainer.html +++ b/api/namespaces/navigation/functions/navigateToContainer.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4184

+

packages/extension-api/src/extension-api.d.ts:4184

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerInspect.html b/api/namespaces/navigation/functions/navigateToContainerInspect.html index 3fda28e474d..54e8bd8f98b 100644 --- a/api/namespaces/navigation/functions/navigateToContainerInspect.html +++ b/api/namespaces/navigation/functions/navigateToContainerInspect.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4188

+

packages/extension-api/src/extension-api.d.ts:4188

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerLogs.html b/api/namespaces/navigation/functions/navigateToContainerLogs.html index 6135eb95368..026cccf9a89 100644 --- a/api/namespaces/navigation/functions/navigateToContainerLogs.html +++ b/api/namespaces/navigation/functions/navigateToContainerLogs.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4186

+

packages/extension-api/src/extension-api.d.ts:4186

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerTerminal.html b/api/namespaces/navigation/functions/navigateToContainerTerminal.html index 94636a4e09e..4934c06e327 100644 --- a/api/namespaces/navigation/functions/navigateToContainerTerminal.html +++ b/api/namespaces/navigation/functions/navigateToContainerTerminal.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4190

+

packages/extension-api/src/extension-api.d.ts:4190

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainers.html b/api/namespaces/navigation/functions/navigateToContainers.html index e2d3e7ee7d8..efd378148dc 100644 --- a/api/namespaces/navigation/functions/navigateToContainers.html +++ b/api/namespaces/navigation/functions/navigateToContainers.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4182

+

packages/extension-api/src/extension-api.d.ts:4182

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContribution.html b/api/namespaces/navigation/functions/navigateToContribution.html index 794b18b8acf..d6fe052e2ed 100644 --- a/api/namespaces/navigation/functions/navigateToContribution.html +++ b/api/namespaces/navigation/functions/navigateToContribution.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4208

+

packages/extension-api/src/extension-api.d.ts:4208

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html index 2cd0e0afe26..711fdc31423 100644 --- a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html +++ b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4230

+

packages/extension-api/src/extension-api.d.ts:4230

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImage.html b/api/namespaces/navigation/functions/navigateToImage.html index af3a1a862eb..2ea06bf6486 100644 --- a/api/namespaces/navigation/functions/navigateToImage.html +++ b/api/namespaces/navigation/functions/navigateToImage.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4195

+

packages/extension-api/src/extension-api.d.ts:4195

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImages.html b/api/namespaces/navigation/functions/navigateToImages.html index 1e1336ce7c1..1c89277ca40 100644 --- a/api/namespaces/navigation/functions/navigateToImages.html +++ b/api/namespaces/navigation/functions/navigateToImages.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4193

+

packages/extension-api/src/extension-api.d.ts:4193

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPod.html b/api/namespaces/navigation/functions/navigateToPod.html index 43a63cf9235..805b8b3d6a5 100644 --- a/api/namespaces/navigation/functions/navigateToPod.html +++ b/api/namespaces/navigation/functions/navigateToPod.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4205

+

packages/extension-api/src/extension-api.d.ts:4205

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPods.html b/api/namespaces/navigation/functions/navigateToPods.html index 8bec65f0cc3..079cb441f62 100644 --- a/api/namespaces/navigation/functions/navigateToPods.html +++ b/api/namespaces/navigation/functions/navigateToPods.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4203

+

packages/extension-api/src/extension-api.d.ts:4203

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToResources.html b/api/namespaces/navigation/functions/navigateToResources.html index ea43f15e622..15f2f1f41bd 100644 --- a/api/namespaces/navigation/functions/navigateToResources.html +++ b/api/namespaces/navigation/functions/navigateToResources.html @@ -13,7 +13,7 @@ - + @@ -25,6 +25,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4226

+

packages/extension-api/src/extension-api.d.ts:4226

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolume.html b/api/namespaces/navigation/functions/navigateToVolume.html index ea812afda92..b512f3d54b0 100644 --- a/api/namespaces/navigation/functions/navigateToVolume.html +++ b/api/namespaces/navigation/functions/navigateToVolume.html @@ -13,7 +13,7 @@ - + @@ -27,6 +27,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4200

+

packages/extension-api/src/extension-api.d.ts:4200

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolumes.html b/api/namespaces/navigation/functions/navigateToVolumes.html index 39e94b389f5..84418875f1d 100644 --- a/api/namespaces/navigation/functions/navigateToVolumes.html +++ b/api/namespaces/navigation/functions/navigateToVolumes.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4198

+

packages/extension-api/src/extension-api.d.ts:4198

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToWebview.html b/api/namespaces/navigation/functions/navigateToWebview.html index d564b414e1e..56f4b70e3f8 100644 --- a/api/namespaces/navigation/functions/navigateToWebview.html +++ b/api/namespaces/navigation/functions/navigateToWebview.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@
  • createWebviewPanel for creating a Webview

    • Source​

    -

    packages/extension-api/src/extension-api.d.ts:4216

    +

    packages/extension-api/src/extension-api.d.ts:4216

    \ No newline at end of file diff --git a/api/namespaces/process.html b/api/namespaces/process.html index 8526feed9db..3c635b4ba08 100644 --- a/api/namespaces/process.html +++ b/api/namespaces/process.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/process/functions/exec.html b/api/namespaces/process/functions/exec.html index 7a9052995ac..0a20f27618a 100644 --- a/api/namespaces/process/functions/exec.html +++ b/api/namespaces/process/functions/exec.html @@ -13,7 +13,7 @@ - + @@ -36,6 +36,6 @@ stdout, and stderr content.

    Throws​

    RunError if provided command can not be executed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:3868

    +

    packages/extension-api/src/extension-api.d.ts:3868

    \ No newline at end of file diff --git a/api/namespaces/provider.html b/api/namespaces/provider.html index 4f91d4318d6..72cc18ef652 100644 --- a/api/namespaces/provider.html +++ b/api/namespaces/provider.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/provider/functions/createProvider.html b/api/namespaces/provider/functions/createProvider.html index 5de6ba62d27..547d9a8dcf0 100644 --- a/api/namespaces/provider/functions/createProvider.html +++ b/api/namespaces/provider/functions/createProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Provider

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:582

    +

    packages/extension-api/src/extension-api.d.ts:582

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getContainerConnections.html b/api/namespaces/provider/functions/getContainerConnections.html index 780ef6047cb..1a1014b7408 100644 --- a/api/namespaces/provider/functions/getContainerConnections.html +++ b/api/namespaces/provider/functions/getContainerConnections.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    ProviderContainerConnection[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:588

    +

    packages/extension-api/src/extension-api.d.ts:588

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/getProviderLifecycleContext.html b/api/namespaces/provider/functions/getProviderLifecycleContext.html index 805eb2b2e54..b0f8cd1ded7 100644 --- a/api/namespaces/provider/functions/getProviderLifecycleContext.html +++ b/api/namespaces/provider/functions/getProviderLifecycleContext.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ If no context is found it throws an error

    Throws​

    if no provider with the id has been found or there is no context associate to it.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:598

    +

    packages/extension-api/src/extension-api.d.ts:598

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html index c57e5e6fcb7..0374e194d79 100644 --- a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:587

    +

    packages/extension-api/src/extension-api.d.ts:587

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html index 7e6b86b8379..661124d453f 100644 --- a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:586

    +

    packages/extension-api/src/extension-api.d.ts:586

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html index c41cf3b517d..4621909ab45 100644 --- a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:584

    +

    packages/extension-api/src/extension-api.d.ts:584

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html index d87733fef4c..78253607c93 100644 --- a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:585

    +

    packages/extension-api/src/extension-api.d.ts:585

    \ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateProvider.html b/api/namespaces/provider/functions/onDidUpdateProvider.html index c5a78e8d2d9..6a30f5cfe84 100644 --- a/api/namespaces/provider/functions/onDidUpdateProvider.html +++ b/api/namespaces/provider/functions/onDidUpdateProvider.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:583

    +

    packages/extension-api/src/extension-api.d.ts:583

    \ No newline at end of file diff --git a/api/namespaces/proxy.html b/api/namespaces/proxy.html index f034f23efcc..d866efbf2ed 100644 --- a/api/namespaces/proxy.html +++ b/api/namespaces/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/proxy/functions/getProxySettings.html b/api/namespaces/proxy/functions/getProxySettings.html index a1386acccdf..b2cfaef1407 100644 --- a/api/namespaces/proxy/functions/getProxySettings.html +++ b/api/namespaces/proxy/functions/getProxySettings.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    ProxySettings | undefined

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:611

    +

    packages/extension-api/src/extension-api.d.ts:611

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/isEnabled.html b/api/namespaces/proxy/functions/isEnabled.html index fc1a22fc0a5..a93bbbfb774 100644 --- a/api/namespaces/proxy/functions/isEnabled.html +++ b/api/namespaces/proxy/functions/isEnabled.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    boolean

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:617

    +

    packages/extension-api/src/extension-api.d.ts:617

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidStateChange.html b/api/namespaces/proxy/functions/onDidStateChange.html index 925f2bb0796..8fd57a16f38 100644 --- a/api/namespaces/proxy/functions/onDidStateChange.html +++ b/api/namespaces/proxy/functions/onDidStateChange.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:618

    +

    packages/extension-api/src/extension-api.d.ts:618

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidUpdateProxy.html b/api/namespaces/proxy/functions/onDidUpdateProxy.html index 708657d91da..33eda96bdb7 100644 --- a/api/namespaces/proxy/functions/onDidUpdateProxy.html +++ b/api/namespaces/proxy/functions/onDidUpdateProxy.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:614

    +

    packages/extension-api/src/extension-api.d.ts:614

    \ No newline at end of file diff --git a/api/namespaces/proxy/functions/setProxy.html b/api/namespaces/proxy/functions/setProxy.html index b77e6101464..cd31eef35a8 100644 --- a/api/namespaces/proxy/functions/setProxy.html +++ b/api/namespaces/proxy/functions/setProxy.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Promise<void>

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:612

    +

    packages/extension-api/src/extension-api.d.ts:612

    \ No newline at end of file diff --git a/api/namespaces/registry.html b/api/namespaces/registry.html index 4b784c9a578..f8c29023c6d 100644 --- a/api/namespaces/registry.html +++ b/api/namespaces/registry.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/registry/functions/onDidRegisterRegistry.html b/api/namespaces/registry/functions/onDidRegisterRegistry.html index d7eefe6bce2..8716de97bb1 100644 --- a/api/namespaces/registry/functions/onDidRegisterRegistry.html +++ b/api/namespaces/registry/functions/onDidRegisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:668

    +

    packages/extension-api/src/extension-api.d.ts:668

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUnregisterRegistry.html b/api/namespaces/registry/functions/onDidUnregisterRegistry.html index ecc71dcdf3b..842068682bf 100644 --- a/api/namespaces/registry/functions/onDidUnregisterRegistry.html +++ b/api/namespaces/registry/functions/onDidUnregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:670

    +

    packages/extension-api/src/extension-api.d.ts:670

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUpdateRegistry.html b/api/namespaces/registry/functions/onDidUpdateRegistry.html index 4cdc240f284..8d04e2bad44 100644 --- a/api/namespaces/registry/functions/onDidUpdateRegistry.html +++ b/api/namespaces/registry/functions/onDidUpdateRegistry.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@

    Disposable

    A disposable which unsubscribes the event listener.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:669

    +

    packages/extension-api/src/extension-api.d.ts:669

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistry.html b/api/namespaces/registry/functions/registerRegistry.html index 4cdc7566eef..c3ee9d8e9af 100644 --- a/api/namespaces/registry/functions/registerRegistry.html +++ b/api/namespaces/registry/functions/registerRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:660

    +

    packages/extension-api/src/extension-api.d.ts:660

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistryProvider.html b/api/namespaces/registry/functions/registerRegistryProvider.html index 7551552105c..6a4f8781b14 100644 --- a/api/namespaces/registry/functions/registerRegistryProvider.html +++ b/api/namespaces/registry/functions/registerRegistryProvider.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:657

    +

    packages/extension-api/src/extension-api.d.ts:657

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/suggestRegistry.html b/api/namespaces/registry/functions/suggestRegistry.html index 5ad848033c1..86038cb5fce 100644 --- a/api/namespaces/registry/functions/suggestRegistry.html +++ b/api/namespaces/registry/functions/suggestRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:666

    +

    packages/extension-api/src/extension-api.d.ts:666

    \ No newline at end of file diff --git a/api/namespaces/registry/functions/unregisterRegistry.html b/api/namespaces/registry/functions/unregisterRegistry.html index a06ebdfd0b0..8e51a882f04 100644 --- a/api/namespaces/registry/functions/unregisterRegistry.html +++ b/api/namespaces/registry/functions/unregisterRegistry.html @@ -13,7 +13,7 @@ - + @@ -26,6 +26,6 @@

    Returns​

    void

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:663

    +

    packages/extension-api/src/extension-api.d.ts:663

    \ No newline at end of file diff --git a/api/namespaces/tray.html b/api/namespaces/tray.html index e0d066bcbe3..dd122852156 100644 --- a/api/namespaces/tray.html +++ b/api/namespaces/tray.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/tray/functions/registerMenuItem.html b/api/namespaces/tray/functions/registerMenuItem.html index 882bbc3053d..9cbefb4872e 100644 --- a/api/namespaces/tray/functions/registerMenuItem.html +++ b/api/namespaces/tray/functions/registerMenuItem.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:678

    +

    packages/extension-api/src/extension-api.d.ts:678

    \ No newline at end of file diff --git a/api/namespaces/tray/functions/registerProviderMenuItem.html b/api/namespaces/tray/functions/registerProviderMenuItem.html index ce5c245e939..211d9501810 100644 --- a/api/namespaces/tray/functions/registerProviderMenuItem.html +++ b/api/namespaces/tray/functions/registerProviderMenuItem.html @@ -13,7 +13,7 @@ - + @@ -29,6 +29,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:685

    +

    packages/extension-api/src/extension-api.d.ts:685

    \ No newline at end of file diff --git a/api/namespaces/window.html b/api/namespaces/window.html index 997885a97b4..242469d089e 100644 --- a/api/namespaces/window.html +++ b/api/namespaces/window.html @@ -13,7 +13,7 @@ - + diff --git a/api/namespaces/window/functions/createCustomPick.html b/api/namespaces/window/functions/createCustomPick.html index 3f9d05aaab1..9eb9299a050 100644 --- a/api/namespaces/window/functions/createCustomPick.html +++ b/api/namespaces/window/functions/createCustomPick.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    CustomPick<T>

    A new CustomPick

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1822

    +

    packages/extension-api/src/extension-api.d.ts:1822

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createStatusBarItem.html b/api/namespaces/window/functions/createStatusBarItem.html index 3fb5a5315cd..295b3f16007 100644 --- a/api/namespaces/window/functions/createStatusBarItem.html +++ b/api/namespaces/window/functions/createStatusBarItem.html @@ -13,7 +13,7 @@ - + @@ -31,6 +31,6 @@

    StatusBarItem

    A new status bar item.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1729

    +

    packages/extension-api/src/extension-api.d.ts:1729

    \ No newline at end of file diff --git a/api/namespaces/window/functions/createWebviewPanel.html b/api/namespaces/window/functions/createWebviewPanel.html index 82e63c50cd9..4b18b5f5c4e 100644 --- a/api/namespaces/window/functions/createWebviewPanel.html +++ b/api/namespaces/window/functions/createWebviewPanel.html @@ -13,7 +13,7 @@ - + @@ -33,6 +33,6 @@

    WebviewPanel

    New webview panel.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1833

    +

    packages/extension-api/src/extension-api.d.ts:1833

    \ No newline at end of file diff --git a/api/namespaces/window/functions/listWebviews.html b/api/namespaces/window/functions/listWebviews.html index 62918994b7e..4ae72d40843 100644 --- a/api/namespaces/window/functions/listWebviews.html +++ b/api/namespaces/window/functions/listWebviews.html @@ -13,7 +13,7 @@ - + @@ -24,6 +24,6 @@

    Returns​

    Promise <WebviewInfo[]>

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1835

    +

    packages/extension-api/src/extension-api.d.ts:1835

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showErrorMessage.html b/api/namespaces/window/functions/showErrorMessage.html index 89b0afe5287..8f431d131c7 100644 --- a/api/namespaces/window/functions/showErrorMessage.html +++ b/api/namespaces/window/functions/showErrorMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1650

    +

    packages/extension-api/src/extension-api.d.ts:1650

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInformationMessage.html b/api/namespaces/window/functions/showInformationMessage.html index e31154c2e57..7a63a0f299e 100644 --- a/api/namespaces/window/functions/showInformationMessage.html +++ b/api/namespaces/window/functions/showInformationMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1630

    +

    packages/extension-api/src/extension-api.d.ts:1630

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showInputBox.html b/api/namespaces/window/functions/showInputBox.html index 193c5f64237..1d15ac0d43a 100644 --- a/api/namespaces/window/functions/showInputBox.html +++ b/api/namespaces/window/functions/showInputBox.html @@ -13,7 +13,7 @@ - + @@ -34,6 +34,6 @@ anything but dismissed the input box with OK.

    Promise<string | undefined>

    A promise that resolves to a string the user provided or to undefined in case of dismissal.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1742

    +

    packages/extension-api/src/extension-api.d.ts:1742

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showNotification.html b/api/namespaces/window/functions/showNotification.html index 842937bbae5..181e63adde2 100644 --- a/api/namespaces/window/functions/showNotification.html +++ b/api/namespaces/window/functions/showNotification.html @@ -13,7 +13,7 @@ - + @@ -28,6 +28,6 @@

    Returns​

    Disposable

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1720

    +

    packages/extension-api/src/extension-api.d.ts:1720

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showOpenDialog.html b/api/namespaces/window/functions/showOpenDialog.html index 89e1c4e1479..89933f9f704 100644 --- a/api/namespaces/window/functions/showOpenDialog.html +++ b/api/namespaces/window/functions/showOpenDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for opening-purposes.

    Promise <Uri[] | undefined>

    A promise that resolves to the selected resources or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1751

    +

    packages/extension-api/src/extension-api.d.ts:1751

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showQuickPick.html b/api/namespaces/window/functions/showQuickPick.html index d0f17c7bb41..b6538cdf0a4 100644 --- a/api/namespaces/window/functions/showQuickPick.html +++ b/api/namespaces/window/functions/showQuickPick.html @@ -13,7 +13,7 @@ - + @@ -34,7 +34,7 @@

    Promise<string[] | undefined>

    A promise that resolves to the selected items or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1770

    +

    packages/extension-api/src/extension-api.d.ts:1770

    showQuickPick(items, options, token)​

    showQuickPick(items, options?, token?): Promise<string | undefined>

    @@ -51,7 +51,7 @@

    Promise<string | undefined>

    A promise that resolves to the selection or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1784

    +

    packages/extension-api/src/extension-api.d.ts:1784

    showQuickPick(items, options, token)​

    showQuickPick<T>(items, options, token?): Promise<T[] | undefined>

    @@ -70,7 +70,7 @@

    Promise<T[] | undefined>

    A promise that resolves to the selected items or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1798

    +

    packages/extension-api/src/extension-api.d.ts:1798

    showQuickPick(items, options, token)​

    showQuickPick<T>(items, options?, token?): Promise<T | undefined>

    @@ -89,6 +89,6 @@

    Promise<T | undefined>

    A promise that resolves to the selected item or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1812

    +

    packages/extension-api/src/extension-api.d.ts:1812

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showSaveDialog.html b/api/namespaces/window/functions/showSaveDialog.html index a01a8c31fbb..52c4691743c 100644 --- a/api/namespaces/window/functions/showSaveDialog.html +++ b/api/namespaces/window/functions/showSaveDialog.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ for saving-purposes.

    Promise <Uri | undefined>

    A promise that resolves to the selected resource or undefined.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1760

    +

    packages/extension-api/src/extension-api.d.ts:1760

    \ No newline at end of file diff --git a/api/namespaces/window/functions/showWarningMessage.html b/api/namespaces/window/functions/showWarningMessage.html index 0cfb8449e87..ff75e63db14 100644 --- a/api/namespaces/window/functions/showWarningMessage.html +++ b/api/namespaces/window/functions/showWarningMessage.html @@ -13,7 +13,7 @@ - + @@ -32,6 +32,6 @@ clickable buttons.

    Promise<string | undefined>

    A promise that resolves to the selected item or undefined when being dismissed.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1640

    +

    packages/extension-api/src/extension-api.d.ts:1640

    \ No newline at end of file diff --git a/api/namespaces/window/functions/withProgress.html b/api/namespaces/window/functions/withProgress.html index 39e32c350e4..0c8aaa3ede3 100644 --- a/api/namespaces/window/functions/withProgress.html +++ b/api/namespaces/window/functions/withProgress.html @@ -13,7 +13,7 @@ - + @@ -50,6 +50,6 @@ long-running operation.

    You can return a value from the task callback

    const result: number = await window.withProgress<number>(
       { location: ProgressLocation.TASK_WIDGET, title: `Running task` },
       async progress => {
          // compute something
          return 55;
       },
    );

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1711

    +

    packages/extension-api/src/extension-api.d.ts:1711

    \ No newline at end of file diff --git a/api/type-aliases/CheckResultLink.html b/api/type-aliases/CheckResultLink.html index 0adf55b2f17..6e4ea12a7a3 100644 --- a/api/type-aliases/CheckResultLink.html +++ b/api/type-aliases/CheckResultLink.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CheckResultLink: Link

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:392

    +

    packages/extension-api/src/extension-api.d.ts:392

    \ No newline at end of file diff --git a/api/type-aliases/CliToolState.html b/api/type-aliases/CliToolState.html index 9b9f2202766..f60860b77ea 100644 --- a/api/type-aliases/CliToolState.html +++ b/api/type-aliases/CliToolState.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    CliToolState: "registered"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:4071

    +

    packages/extension-api/src/extension-api.d.ts:4071

    \ No newline at end of file diff --git a/api/type-aliases/ConfigurationScope.html b/api/type-aliases/ConfigurationScope.html index 83e4a4564a2..46c784c49c7 100644 --- a/api/type-aliases/ConfigurationScope.html +++ b/api/type-aliases/ConfigurationScope.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The configuration scope

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:700

    +

    packages/extension-api/src/extension-api.d.ts:700

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorArgument.html b/api/type-aliases/KubernetesGeneratorArgument.html index 85b92e7f897..daa0ba184a5 100644 --- a/api/type-aliases/KubernetesGeneratorArgument.html +++ b/api/type-aliases/KubernetesGeneratorArgument.html @@ -13,7 +13,7 @@ - + @@ -39,6 +39,6 @@

    optional pods: string[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1878

    +

    packages/extension-api/src/extension-api.d.ts:1878

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorSelector.html b/api/type-aliases/KubernetesGeneratorSelector.html index 3da6fcecf09..3d06cf638d6 100644 --- a/api/type-aliases/KubernetesGeneratorSelector.html +++ b/api/type-aliases/KubernetesGeneratorSelector.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorSelector: KubernetesGeneratorType | ReadonlyArray <KubernetesGeneratorType>

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1867

    +

    packages/extension-api/src/extension-api.d.ts:1867

    \ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorType.html b/api/type-aliases/KubernetesGeneratorType.html index abdd5d7fc65..75619c33209 100644 --- a/api/type-aliases/KubernetesGeneratorType.html +++ b/api/type-aliases/KubernetesGeneratorType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    KubernetesGeneratorType: "Compose" | "Pod" | "Container"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1869

    +

    packages/extension-api/src/extension-api.d.ts:1869

    \ No newline at end of file diff --git a/api/type-aliases/MountConfig.html b/api/type-aliases/MountConfig.html index 9cce3a1f674..00c8c7ffc2d 100644 --- a/api/type-aliases/MountConfig.html +++ b/api/type-aliases/MountConfig.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConfig: MountSettings[]

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2157

    +

    packages/extension-api/src/extension-api.d.ts:2157

    \ No newline at end of file diff --git a/api/type-aliases/MountConsistency.html b/api/type-aliases/MountConsistency.html index 03ea2e8fcad..34a16292c84 100644 --- a/api/type-aliases/MountConsistency.html +++ b/api/type-aliases/MountConsistency.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountConsistency: "default" | "consistent" | "cached" | "delegated"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2129

    +

    packages/extension-api/src/extension-api.d.ts:2129

    \ No newline at end of file diff --git a/api/type-aliases/MountPropagation.html b/api/type-aliases/MountPropagation.html index cc632fe9ee9..8f8b09b3532 100644 --- a/api/type-aliases/MountPropagation.html +++ b/api/type-aliases/MountPropagation.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountPropagation: "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2131

    +

    packages/extension-api/src/extension-api.d.ts:2131

    \ No newline at end of file diff --git a/api/type-aliases/MountType.html b/api/type-aliases/MountType.html index 50bbbf2aae2..8a4e0a249fe 100644 --- a/api/type-aliases/MountType.html +++ b/api/type-aliases/MountType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    MountType: "bind" | "volume" | "tmpfs"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:2127

    +

    packages/extension-api/src/extension-api.d.ts:2127

    \ No newline at end of file diff --git a/api/type-aliases/NotificationType.html b/api/type-aliases/NotificationType.html index b51d2aa3b48..231acca84e1 100644 --- a/api/type-aliases/NotificationType.html +++ b/api/type-aliases/NotificationType.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    NotificationType: "info" | "warn" | "error"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1188

    +

    packages/extension-api/src/extension-api.d.ts:1188

    \ No newline at end of file diff --git a/api/type-aliases/ProviderConnectionStatus.html b/api/type-aliases/ProviderConnectionStatus.html index 2213134d16c..50d02c253b4 100644 --- a/api/type-aliases/ProviderConnectionStatus.html +++ b/api/type-aliases/ProviderConnectionStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderConnectionStatus: "started" | "stopped" | "starting" | "stopping" | "unknown"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:251

    +

    packages/extension-api/src/extension-api.d.ts:251

    \ No newline at end of file diff --git a/api/type-aliases/ProviderLinks.html b/api/type-aliases/ProviderLinks.html index c76d777f1f5..a8717388e96 100644 --- a/api/type-aliases/ProviderLinks.html +++ b/api/type-aliases/ProviderLinks.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderLinks: Link

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:456

    +

    packages/extension-api/src/extension-api.d.ts:456

    \ No newline at end of file diff --git a/api/type-aliases/ProviderResult.html b/api/type-aliases/ProviderResult.html index 355359d39e5..45cfc13a67e 100644 --- a/api/type-aliases/ProviderResult.html +++ b/api/type-aliases/ProviderResult.html @@ -13,7 +13,7 @@ - + @@ -30,6 +30,6 @@ Promise.

    Type parameters​

    • T

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:200

    +

    packages/extension-api/src/extension-api.d.ts:200

    \ No newline at end of file diff --git a/api/type-aliases/ProviderStatus.html b/api/type-aliases/ProviderStatus.html index 15c730337b8..fb6464e3951 100644 --- a/api/type-aliases/ProviderStatus.html +++ b/api/type-aliases/ProviderStatus.html @@ -13,7 +13,7 @@ - + @@ -22,6 +22,6 @@

    ProviderStatus: "not-installed" | "installed" | "configuring" | "configured" | "ready" | "started" | "stopped" | "starting" | "stopping" | "error" | "unknown"

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:202

    +

    packages/extension-api/src/extension-api.d.ts:202

    \ No newline at end of file diff --git a/api/type-aliases/StatusBarAlignment.html b/api/type-aliases/StatusBarAlignment.html index faa558530e0..8502e3967dd 100644 --- a/api/type-aliases/StatusBarAlignment.html +++ b/api/type-aliases/StatusBarAlignment.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Represents the alignment of status bar items.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1228

    +

    packages/extension-api/src/extension-api.d.ts:1228

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignLeft.html b/api/variables/StatusBarAlignLeft.html index 2eceeb05d75..223a399061a 100644 --- a/api/variables/StatusBarAlignLeft.html +++ b/api/variables/StatusBarAlignLeft.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the left side.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1220

    +

    packages/extension-api/src/extension-api.d.ts:1220

    \ No newline at end of file diff --git a/api/variables/StatusBarAlignRight.html b/api/variables/StatusBarAlignRight.html index 4917626a3a7..78fca135e57 100644 --- a/api/variables/StatusBarAlignRight.html +++ b/api/variables/StatusBarAlignRight.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Aligned to the right side.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1224

    +

    packages/extension-api/src/extension-api.d.ts:1224

    \ No newline at end of file diff --git a/api/variables/StatusBarItemDefaultPriority.html b/api/variables/StatusBarItemDefaultPriority.html index 27d8f1f2e61..c48c435941c 100644 --- a/api/variables/StatusBarItemDefaultPriority.html +++ b/api/variables/StatusBarItemDefaultPriority.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    Default priority for the status bar items.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:1233

    +

    packages/extension-api/src/extension-api.d.ts:1233

    \ No newline at end of file diff --git a/api/variables/version.html b/api/variables/version.html index 5982702efcb..aee035d3fef 100644 --- a/api/variables/version.html +++ b/api/variables/version.html @@ -13,7 +13,7 @@ - + @@ -23,6 +23,6 @@

    The version of Podman Desktop.

    Source​

    -

    packages/extension-api/src/extension-api.d.ts:42

    +

    packages/extension-api/src/extension-api.d.ts:42

    \ No newline at end of file diff --git a/assets/js/0029a336.5ed6088f.js b/assets/js/0029a336.37c6ca63.js similarity index 97% rename from assets/js/0029a336.5ed6088f.js rename to assets/js/0029a336.37c6ca63.js index 43c475755a7..23555fbef4c 100644 --- a/assets/js/0029a336.5ed6088f.js +++ b/assets/js/0029a336.37c6ca63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{54168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=s(24246),t=s(71670);const o={},i="Function: withProgress()",a={id:"namespaces/window/functions/withProgress",title:"Function: withProgress()",description:"withProgress\\(options, task): Promise\\",source:"@site/api/namespaces/window/functions/withProgress.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/withProgress",permalink:"/api/namespaces/window/functions/withProgress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"},next:{title:"InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"}},c={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.p,{children:"Here is a simple example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"await window.withProgress({ location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n progress.report({message: 'task1' });\n await task1();\n progress.report({increment: 50, message: 'task2' });\n await task2();\n },\n);\n"})}),"\n",(0,r.jsx)(n.p,{children:"The error is propagated if thrown inside the task callback."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"try {\n await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n throw new Error('error when running a task');\n },\n );\n } catch (error) {\n // do something with the error\n }\n"})}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1711",children:"packages/extension-api/src/extension-api.d.ts:1711"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(27378);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{54168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=s(24246),t=s(71670);const o={},i="Function: withProgress()",a={id:"namespaces/window/functions/withProgress",title:"Function: withProgress()",description:"withProgress\\(options, task): Promise\\",source:"@site/api/namespaces/window/functions/withProgress.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/withProgress",permalink:"/api/namespaces/window/functions/withProgress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"},next:{title:"InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"}},c={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-withprogress",children:"Function: withProgress()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"withProgress"}),"<",(0,r.jsx)(n.code,{children:"R"}),">(",(0,r.jsx)(n.code,{children:"options"}),", ",(0,r.jsx)(n.code,{children:"task"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Show progress in Podman Desktop. Progress is shown while running the given callback\nand while the promise it returned isn't resolved nor rejected. The location at which\nprogress should show (and other details) is defined via the passed ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"R"})]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProgressOptions",children:(0,r.jsx)(n.code,{children:"ProgressOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the options for the task's details"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"task"})]}),"\n",(0,r.jsxs)(n.p,{children:["A callback returning a promise. Progress state can be reported with\nthe provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/Progress",children:"Progress"}),"-object."]}),"\n",(0,r.jsxs)(n.p,{children:["To report discrete progress, use ",(0,r.jsx)(n.code,{children:"increment"})," to indicate how much work has been completed. Each call with\na ",(0,r.jsx)(n.code,{children:"increment"})," value will be summed up and reflected as overall progress until 100% is reached (a value of\ne.g. ",(0,r.jsx)(n.code,{children:"10"})," accounts for ",(0,r.jsx)(n.code,{children:"10%"})," of work done).\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is capable of showing discrete progress."]}),"\n",(0,r.jsxs)(n.p,{children:["To monitor if the operation has been cancelled by the user, use the provided ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})}),".\nNote that currently only ",(0,r.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel button to cancel the\nlong-running operation."]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"R"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"The promise the task-callback returned."}),"\n",(0,r.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.p,{children:"Here is a simple example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"await window.withProgress({ location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n progress.report({message: 'task1' });\n await task1();\n progress.report({increment: 50, message: 'task2' });\n await task2();\n },\n);\n"})}),"\n",(0,r.jsx)(n.p,{children:"The error is propagated if thrown inside the task callback."}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"try {\n await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n throw new Error('error when running a task');\n },\n );\n } catch (error) {\n // do something with the error\n }\n"})}),"\n",(0,r.jsx)(n.p,{children:"You can return a value from the task callback"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const result: number = await window.withProgress(\n { location: ProgressLocation.TASK_WIDGET, title: `Running task` },\n async progress => {\n // compute something\n return 55;\n },\n);\n"})}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1711",children:"packages/extension-api/src/extension-api.d.ts:1711"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>i});var r=s(27378);const t={},o=r.createContext(t);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0102eb3e.39c9d44f.js b/assets/js/0102eb3e.b7e90bcb.js similarity index 92% rename from assets/js/0102eb3e.39c9d44f.js rename to assets/js/0102eb3e.b7e90bcb.js index 67f76e8bde3..8461f6c8db2 100644 --- a/assets/js/0102eb3e.39c9d44f.js +++ b/assets/js/0102eb3e.b7e90bcb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{75013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Interface: WebviewInfo",o={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Webview",permalink:"/api/interfaces/Webview"},next:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2792",children:"packages/extension-api/src/extension-api.d.ts:2792"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2794",children:"packages/extension-api/src/extension-api.d.ts:2794"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2793",children:"packages/extension-api/src/extension-api.d.ts:2793"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{75013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Interface: WebviewInfo",o={id:"interfaces/WebviewInfo",title:"Interface: WebviewInfo",description:"Properties",source:"@site/api/interfaces/WebviewInfo.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewInfo",permalink:"/api/interfaces/WebviewInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Webview",permalink:"/api/interfaces/Webview"},next:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-webviewinfo",children:"Interface: WebviewInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2792",children:"packages/extension-api/src/extension-api.d.ts:2792"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2794",children:"packages/extension-api/src/extension-api.d.ts:2794"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"viewType"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2793",children:"packages/extension-api/src/extension-api.d.ts:2793"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01821883.93437474.js b/assets/js/01821883.f2780b48.js similarity index 90% rename from assets/js/01821883.93437474.js rename to assets/js/01821883.f2780b48.js index d1dfc9a2960..21d96183a4f 100644 --- a/assets/js/01821883.93437474.js +++ b/assets/js/01821883.f2780b48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{94309:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);const t={},r="Interface: DeviceRequest",o={id:"interfaces/DeviceRequest",title:"Interface: DeviceRequest",description:"Properties",source:"@site/api/interfaces/DeviceRequest.md",sourceDirName:"interfaces",slug:"/interfaces/DeviceRequest",permalink:"/api/interfaces/DeviceRequest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"},next:{title:"EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Source",id:"source",level:4},{value:"Count?",id:"count",level:3},{value:"Source",id:"source-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Source",id:"source-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Source",id:"source-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"count",children:"Count?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Count"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"deviceids",children:"DeviceIDs?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"DeviceIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"driver",children:"Driver?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const c={},t=s.createContext(c);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{94309:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=i(24246),c=i(71670);const t={},r="Interface: DeviceRequest",o={id:"interfaces/DeviceRequest",title:"Interface: DeviceRequest",description:"Properties",source:"@site/api/interfaces/DeviceRequest.md",sourceDirName:"interfaces",slug:"/interfaces/DeviceRequest",permalink:"/api/interfaces/DeviceRequest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"},next:{title:"EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Capabilities?",id:"capabilities",level:3},{value:"Source",id:"source",level:4},{value:"Count?",id:"count",level:3},{value:"Source",id:"source-1",level:4},{value:"DeviceIDs?",id:"deviceids",level:3},{value:"Source",id:"source-2",level:4},{value:"Driver?",id:"driver",level:3},{value:"Source",id:"source-3",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-devicerequest",children:"Interface: DeviceRequest"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"capabilities",children:"Capabilities?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Capabilities"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[][]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"count",children:"Count?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Count"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"deviceids",children:"DeviceIDs?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"DeviceIDs"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"driver",children:"Driver?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Driver"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Options"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,s.jsxs)(n.p,{children:["[",(0,s.jsx)(n.code,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"}),"]: ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>r});var s=i(27378);const c={},t=s.createContext(c);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01a1d0f4.6a47b2ca.js b/assets/js/01a1d0f4.9ddc3e8f.js similarity index 96% rename from assets/js/01a1d0f4.6a47b2ca.js rename to assets/js/01a1d0f4.9ddc3e8f.js index 8ee95ca8aa0..8c3207e9ea8 100644 --- a/assets/js/01a1d0f4.6a47b2ca.js +++ b/assets/js/01a1d0f4.9ddc3e8f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{75055:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const o={},t="Function: onDidUnregisterContainerConnection()",c={id:"namespaces/provider/functions/onDidUnregisterContainerConnection",title:"Function: onDidUnregisterContainerConnection()",description:"onDidUnregisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUnregisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"},next:{title:"onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L586",children:"packages/extension-api/src/extension-api.d.ts:586"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{75055:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const o={},t="Function: onDidUnregisterContainerConnection()",c={id:"namespaces/provider/functions/onDidUnregisterContainerConnection",title:"Function: onDidUnregisterContainerConnection()",description:"onDidUnregisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUnregisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"},next:{title:"onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidunregistercontainerconnection",children:"Function: onDidUnregisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUnregisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L586",children:"packages/extension-api/src/extension-api.d.ts:586"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const r={},o=i.createContext(r);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/030ccfd9.3ea085b6.js b/assets/js/030ccfd9.912df305.js similarity index 97% rename from assets/js/030ccfd9.3ea085b6.js rename to assets/js/030ccfd9.912df305.js index 3d255bc4223..123ce1a2d7f 100644 --- a/assets/js/030ccfd9.3ea085b6.js +++ b/assets/js/030ccfd9.912df305.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{48300:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>u});var s=t(24246),c=t(71670);const o={},i="Function: getKubeconfig()",r={id:"namespaces/kubernetes/functions/getKubeconfig",title:"Function: getKubeconfig()",description:"getKubeconfig(): Uri",source:"@site/api/namespaces/kubernetes/functions/getKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createResources",permalink:"/api/namespaces/kubernetes/functions/createResources"},next:{title:"onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"}},a={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1840",children:"packages/extension-api/src/extension-api.d.ts:1840"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{48300:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>u});var s=t(24246),c=t(71670);const o={},i="Function: getKubeconfig()",r={id:"namespaces/kubernetes/functions/getKubeconfig",title:"Function: getKubeconfig()",description:"getKubeconfig(): Uri",source:"@site/api/namespaces/kubernetes/functions/getKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createResources",permalink:"/api/namespaces/kubernetes/functions/createResources"},next:{title:"onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"}},a={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getkubeconfig",children:"Function: getKubeconfig()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getKubeconfig"}),"(): ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1840",children:"packages/extension-api/src/extension-api.d.ts:1840"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/04a546a4.6bff2a6d.js b/assets/js/04a546a4.dd5b95ce.js similarity index 86% rename from assets/js/04a546a4.6bff2a6d.js rename to assets/js/04a546a4.dd5b95ce.js index 19f2bed57d7..a8a7160df59 100644 --- a/assets/js/04a546a4.6bff2a6d.js +++ b/assets/js/04a546a4.dd5b95ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{27848:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var t=r(24246),s=r(71670);const i={},c="Interface: Clipboard",d={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Command",permalink:"/api/interfaces/Command"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"}),"\n",(0,t.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"readText"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4008",children:"packages/extension-api/src/extension-api.d.ts:4008"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"writeText"}),"(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Writes text into the clipboard."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4014",children:"packages/extension-api/src/extension-api.d.ts:4014"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{27848:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const i={},c="Interface: Clipboard",o={id:"interfaces/Clipboard",title:"Interface: Clipboard",description:"The clipboard provides read and write access to the system's clipboard.",source:"@site/api/interfaces/Clipboard.md",sourceDirName:"interfaces",slug:"/interfaces/Clipboard",permalink:"/api/interfaces/Clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"},next:{title:"Command",permalink:"/api/interfaces/Command"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"readText()",id:"readtext",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"writeText()",id:"writetext",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clipboard",children:"Interface: Clipboard"}),"\n",(0,t.jsx)(n.p,{children:"The clipboard provides read and write access to the system's clipboard."}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"readtext",children:"readText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"readText"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Read the current clipboard contents as text."}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves to a string."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4008",children:"packages/extension-api/src/extension-api.d.ts:4008"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"writetext",children:"writeText()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"writeText"}),"(",(0,t.jsx)(n.code,{children:"value"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Writes text into the clipboard."}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"value"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A Promise that resolves when writing happened."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4014",children:"packages/extension-api/src/extension-api.d.ts:4014"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0547cb65.8c078732.js b/assets/js/0547cb65.41c1dd1f.js similarity index 95% rename from assets/js/0547cb65.8c078732.js rename to assets/js/0547cb65.41c1dd1f.js index 04496e76979..605ed82e735 100644 --- a/assets/js/0547cb65.8c078732.js +++ b/assets/js/0547cb65.41c1dd1f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{41694:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=i(24246),r=i(71670);const c={},s="Enumeration: QuickPickItemKind",a={id:"enumerations/QuickPickItemKind",title:"Enumeration: QuickPickItemKind",description:"The kind of quick pick item.",source:"@site/api/enumerations/QuickPickItemKind.md",sourceDirName:"enumerations",slug:"/enumerations/QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"},next:{title:"CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"}},o={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Default",id:"default",level:3},{value:"Source",id:"source",level:4},{value:"Separator",id:"separator",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L955",children:"packages/extension-api/src/extension-api.d.ts:955"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"separator",children:"Separator"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Separator"}),": ",(0,t.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," has a kind of ",(0,t.jsx)(n.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"Separator"}),", the item is just a visual separator and does not represent a real item.\nThe only property that applies is ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#label",children:"label "}),". All other properties on ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," will be ignored and have no effect."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L951",children:"packages/extension-api/src/extension-api.d.ts:951"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},c=t.createContext(r);function s(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{41694:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=i(24246),r=i(71670);const c={},s="Enumeration: QuickPickItemKind",a={id:"enumerations/QuickPickItemKind",title:"Enumeration: QuickPickItemKind",description:"The kind of quick pick item.",source:"@site/api/enumerations/QuickPickItemKind.md",sourceDirName:"enumerations",slug:"/enumerations/QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"},next:{title:"CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"}},o={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Default",id:"default",level:3},{value:"Source",id:"source",level:4},{value:"Separator",id:"separator",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-quickpickitemkind",children:"Enumeration: QuickPickItemKind"}),"\n",(0,t.jsxs)(n.p,{children:["The kind of ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"quick pick item"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"default",children:"Default"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Default"}),": ",(0,t.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The default ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#kind",children:"QuickPickItem.kind"})," is an item that can be selected in the quick pick."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L955",children:"packages/extension-api/src/extension-api.d.ts:955"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"separator",children:"Separator"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Separator"}),": ",(0,t.jsx)(n.code,{children:"-1"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["When a ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," has a kind of ",(0,t.jsx)(n.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"Separator"}),", the item is just a visual separator and does not represent a real item.\nThe only property that applies is ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem#label",children:"label "}),". All other properties on ",(0,t.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:"QuickPickItem"})," will be ignored and have no effect."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L951",children:"packages/extension-api/src/extension-api.d.ts:951"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const r={},c=t.createContext(r);function s(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/065365b3.63c19168.js b/assets/js/065365b3.b2c7e967.js similarity index 94% rename from assets/js/065365b3.63c19168.js rename to assets/js/065365b3.b2c7e967.js index aad19998c2e..6662459b60f 100644 --- a/assets/js/065365b3.63c19168.js +++ b/assets/js/065365b3.b2c7e967.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{62480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>h});var c=t(24246),r=t(71670);const s={},a="Interface: ImageChecks",i={id:"interfaces/ImageChecks",title:"Interface: ImageChecks",description:"the complete result of an image check",source:"@site/api/interfaces/ImageChecks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageChecks",permalink:"/api/interfaces/ImageChecks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"},next:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},h=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4136",children:"packages/extension-api/src/extension-api.d.ts:4136"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var c=t(27378);const r={},s=c.createContext(r);function a(e){const n=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),c.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{62480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>h});var c=t(24246),r=t(71670);const s={},a="Interface: ImageChecks",i={id:"interfaces/ImageChecks",title:"Interface: ImageChecks",description:"the complete result of an image check",source:"@site/api/interfaces/ImageChecks.md",sourceDirName:"interfaces",slug:"/interfaces/ImageChecks",permalink:"/api/interfaces/ImageChecks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"},next:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"}},o={},h=[{value:"Properties",id:"properties",level:2},{value:"checks",id:"checks",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,c.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"checks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,c.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4136",children:"packages/extension-api/src/extension-api.d.ts:4136"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>a});var c=t(27378);const r={},s=c.createContext(r);function a(e){const n=c.useContext(s);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),c.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.a0709e0d.js b/assets/js/06a27da2.70f42b7e.js similarity index 81% rename from assets/js/06a27da2.a0709e0d.js rename to assets/js/06a27da2.70f42b7e.js index 77f0173e4a5..183dab7dc79 100644 --- a/assets/js/06a27da2.a0709e0d.js +++ b/assets/js/06a27da2.70f42b7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{44400:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const c={},d="Interface: PodInfo",o={id:"interfaces/PodInfo",title:"Interface: PodInfo",description:"Properties",source:"@site/api/interfaces/PodInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodInfo",permalink:"/api/interfaces/PodInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"},next:{title:"PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Source",id:"source",level:4},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source-1",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Source",id:"source-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Source",id:"source-8",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4},{value:"kind",id:"kind",level:3},{value:"Source",id:"source-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2087",children:"packages/extension-api/src/extension-api.d.ts:2087"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,i.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2088",children:"packages/extension-api/src/extension-api.d.ts:2088"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2089",children:"packages/extension-api/src/extension-api.d.ts:2089"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2090",children:"packages/extension-api/src/extension-api.d.ts:2090"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"InfraId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2091",children:"packages/extension-api/src/extension-api.d.ts:2091"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2093",children:"packages/extension-api/src/extension-api.d.ts:2093"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Namespace"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2094",children:"packages/extension-api/src/extension-api.d.ts:2094"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2095",children:"packages/extension-api/src/extension-api.d.ts:2095"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:'"podman"'})," | ",(0,i.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2086",children:"packages/extension-api/src/extension-api.d.ts:2086"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var i=s(27378);const r={},c=i.createContext(r);function d(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{44400:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: PodInfo",d={id:"interfaces/PodInfo",title:"Interface: PodInfo",description:"Properties",source:"@site/api/interfaces/PodInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodInfo",permalink:"/api/interfaces/PodInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"},next:{title:"PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Cgroup",id:"cgroup",level:3},{value:"Source",id:"source",level:4},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source-1",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"InfraId",id:"infraid",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"Namespace",id:"namespace",level:3},{value:"Source",id:"source-7",level:4},{value:"Networks",id:"networks",level:3},{value:"Source",id:"source-8",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4},{value:"kind",id:"kind",level:3},{value:"Source",id:"source-12",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2087",children:"packages/extension-api/src/extension-api.d.ts:2087"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,i.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2088",children:"packages/extension-api/src/extension-api.d.ts:2088"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2089",children:"packages/extension-api/src/extension-api.d.ts:2089"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2090",children:"packages/extension-api/src/extension-api.d.ts:2090"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"InfraId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2091",children:"packages/extension-api/src/extension-api.d.ts:2091"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2093",children:"packages/extension-api/src/extension-api.d.ts:2093"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Namespace"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2094",children:"packages/extension-api/src/extension-api.d.ts:2094"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2095",children:"packages/extension-api/src/extension-api.d.ts:2095"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:'"podman"'})," | ",(0,i.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2086",children:"packages/extension-api/src/extension-api.d.ts:2086"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0877aebd.2a76274c.js b/assets/js/0877aebd.d8fd10e3.js similarity index 94% rename from assets/js/0877aebd.2a76274c.js rename to assets/js/0877aebd.d8fd10e3.js index 9ee27704b82..2ee9352a6b5 100644 --- a/assets/js/0877aebd.2a76274c.js +++ b/assets/js/0877aebd.d8fd10e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{87044:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: AuthenticationProviderOptions",c={id:"interfaces/AuthenticationProviderOptions",title:"Interface: AuthenticationProviderOptions",description:"Options for creating an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"},next:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"images?",id:"images",level:3},{value:"Source",id:"source",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"}),"\n",(0,i.jsxs)(n.p,{children:["Options for creating an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3560",children:"packages/extension-api/src/extension-api.d.ts:3560"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether it is possible to be signed into multiple accounts at once with this provider.\nIf not specified, will default to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3558",children:"packages/extension-api/src/extension-api.d.ts:3558"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{87044:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: AuthenticationProviderOptions",c={id:"interfaces/AuthenticationProviderOptions",title:"Interface: AuthenticationProviderOptions",description:"Options for creating an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"},next:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"images?",id:"images",level:3},{value:"Source",id:"source",level:4},{value:"supportsMultipleAccounts?",id:"supportsmultipleaccounts",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationprovideroptions",children:"Interface: AuthenticationProviderOptions"}),"\n",(0,i.jsxs)(n.p,{children:["Options for creating an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3560",children:"packages/extension-api/src/extension-api.d.ts:3560"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"supportsmultipleaccounts",children:"supportsMultipleAccounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"supportsMultipleAccounts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether it is possible to be signed into multiple accounts at once with this provider.\nIf not specified, will default to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3558",children:"packages/extension-api/src/extension-api.d.ts:3558"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c14b239.b781dbf6.js b/assets/js/0c14b239.bddcfa60.js similarity index 83% rename from assets/js/0c14b239.b781dbf6.js rename to assets/js/0c14b239.bddcfa60.js index f37931e1889..ba19a054d34 100644 --- a/assets/js/0c14b239.b781dbf6.js +++ b/assets/js/0c14b239.bddcfa60.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{22902:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var s=i(24246),o=i(71670);const t={},a="Function: onDidChangeConfiguration()",r={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(e.p,{children:["An event that is emitted when the ",(0,s.jsx)(e.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>a});var s=i(27378);const o={},t=s.createContext(o);function a(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:a(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{22902:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var s=i(24246),o=i(71670);const t={},r="Function: onDidChangeConfiguration()",a={id:"namespaces/configuration/functions/onDidChangeConfiguration",title:"Function: onDidChangeConfiguration()",description:"onDidChangeConfiguration(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration"},next:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-ondidchangeconfiguration",children:"Function: onDidChangeConfiguration()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"onDidChangeConfiguration"}),"(",(0,s.jsx)(e.code,{children:"listener"}),", ",(0,s.jsx)(e.code,{children:"thisArgs"}),"?, ",(0,s.jsx)(e.code,{children:"disposables"}),"?): ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsxs)(e.p,{children:["An event that is emitted when the ",(0,s.jsx)(e.a,{href:"/api/interfaces/Configuration",children:"configuration"})," changed."]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"listener"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"thisArgs?"}),": ",(0,s.jsx)(e.code,{children:"any"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"disposables?"}),": ",(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})}),"[]"]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>a,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(n){const e=s.useContext(t);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:r(n.components),s.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c4fad6b.ff14b025.js b/assets/js/0c4fad6b.f315177e.js similarity index 95% rename from assets/js/0c4fad6b.ff14b025.js rename to assets/js/0c4fad6b.f315177e.js index d7ebafc3bfa..b15207b2834 100644 --- a/assets/js/0c4fad6b.ff14b025.js +++ b/assets/js/0c4fad6b.f315177e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{14649:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"},next:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4221",children:"packages/extension-api/src/extension-api.d.ts:4221"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{14649:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var i=t(24246),a=t(71670);const o={},s="Function: navigateToAuthentication()",c={id:"namespaces/navigation/functions/navigateToAuthentication",title:"Function: navigateToAuthentication()",description:"navigateToAuthentication(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"},next:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetoauthentication",children:"Function: navigateToAuthentication()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToAuthentication"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Navigate to Authentication settings page"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4221",children:"packages/extension-api/src/extension-api.d.ts:4221"})})]})}function p(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/0cab2b3a.ffdf50f5.js b/assets/js/0cab2b3a.836f2002.js similarity index 93% rename from assets/js/0cab2b3a.ffdf50f5.js rename to assets/js/0cab2b3a.836f2002.js index 3023b848d7e..bb150e1b192 100644 --- a/assets/js/0cab2b3a.ffdf50f5.js +++ b/assets/js/0cab2b3a.836f2002.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{68282:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>i});var t=s(24246),r=s(71670);const c={},o="Function: executeCommand()",a={id:"namespaces/commands/functions/executeCommand",title:"Function: executeCommand()",description:"executeCommand\\(command, ...rest): PromiseLike\\",source:"@site/api/namespaces/commands/functions/executeCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"},next:{title:"registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand"}},d={},i=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Throws",id:"throws-1",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L542",children:"packages/extension-api/src/extension-api.d.ts:542"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{68282:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=s(24246),r=s(71670);const c={},o="Function: executeCommand()",a={id:"namespaces/commands/functions/executeCommand",title:"Function: executeCommand()",description:"executeCommand\\(command, ...rest): PromiseLike\\",source:"@site/api/namespaces/commands/functions/executeCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"},next:{title:"registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Throws",id:"throws-1",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-executecommand",children:"Function: executeCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"executeCommand"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"command"}),", ...",(0,t.jsx)(n.code,{children:"rest"}),"): ",(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Execute a command, previously registered with ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"})]}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})," = ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsx)(n.p,{children:"the type of the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name used for registering the command"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ...",(0,t.jsx)(n.strong,{children:"rest"}),": ",(0,t.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the parameters to pass to the command"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"PromiseLike"}),"<",(0,t.jsx)(n.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"the value returned by the command"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command is not registered"}),"\n",(0,t.jsx)(n.h2,{id:"throws-1",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if the command throws an exception"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L542",children:"packages/extension-api/src/extension-api.d.ts:542"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e3a398f.ad507ffe.js b/assets/js/0e3a398f.636f207f.js similarity index 94% rename from assets/js/0e3a398f.ad507ffe.js rename to assets/js/0e3a398f.636f207f.js index 82a6a151d56..bcedb4246d1 100644 --- a/assets/js/0e3a398f.ad507ffe.js +++ b/assets/js/0e3a398f.636f207f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{78814:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const i={},s="Interface: KubernetesProviderConnectionEndpoint",c={id:"interfaces/KubernetesProviderConnectionEndpoint",title:"Interface: KubernetesProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"},next:{title:"KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L336",children:"packages/extension-api/src/extension-api.d.ts:336"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const o={},i=r.createContext(o);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{78814:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const i={},s="Interface: KubernetesProviderConnectionEndpoint",c={id:"interfaces/KubernetesProviderConnectionEndpoint",title:"Interface: KubernetesProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"},next:{title:"KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"apiURL",id:"apiurl",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionendpoint",children:"Interface: KubernetesProviderConnectionEndpoint"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"apiurl",children:"apiURL"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"apiURL"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L336",children:"packages/extension-api/src/extension-api.d.ts:336"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const o={},i=r.createContext(o);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e72c11a.c2a17831.js b/assets/js/0e72c11a.60904b68.js similarity index 81% rename from assets/js/0e72c11a.c2a17831.js rename to assets/js/0e72c11a.60904b68.js index 6be8ab45405..1ca45e4b5c9 100644 --- a/assets/js/0e72c11a.c2a17831.js +++ b/assets/js/0e72c11a.60904b68.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{51215:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var o=s(24246),t=s(71670);const a={},i="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Navigate to Resources page"}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4226",children:"packages/extension-api/src/extension-api.d.ts:4226"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var o=s(27378);const t={},a=o.createContext(t);function i(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{51215:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=s(24246),t=s(71670);const i={},a="Function: navigateToResources()",c={id:"namespaces/navigation/functions/navigateToResources",title:"Function: navigateToResources()",description:"navigateToResources(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToResources.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"},next:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetoresources",children:"Function: navigateToResources()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToResources"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Navigate to Resources page"}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4226",children:"packages/extension-api/src/extension-api.d.ts:4226"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var o=s(27378);const t={},i=o.createContext(t);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0f54081d.c9338352.js b/assets/js/0f54081d.a43bded5.js similarity index 98% rename from assets/js/0f54081d.c9338352.js rename to assets/js/0f54081d.a43bded5.js index c57804cc6a8..c97191f9de3 100644 --- a/assets/js/0f54081d.c9338352.js +++ b/assets/js/0f54081d.a43bded5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{25361:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>a});var r=t(24246),o=t(71670);const i={},c="Function: getProviderLifecycleContext()",s={id:"namespaces/provider/functions/getProviderLifecycleContext",title:"Function: getProviderLifecycleContext()",description:"getProviderLifecycleContext(providerId, containerProviderConnection): LifecycleContext",source:"@site/api/namespaces/provider/functions/getProviderLifecycleContext.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"},next:{title:"onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,r.jsx)(n.code,{children:"providerId"}),", ",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"the provider id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,r.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var r=t(27378);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{25361:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>a});var r=t(24246),o=t(71670);const i={},c="Function: getProviderLifecycleContext()",s={id:"namespaces/provider/functions/getProviderLifecycleContext",title:"Function: getProviderLifecycleContext()",description:"getProviderLifecycleContext(providerId, containerProviderConnection): LifecycleContext",source:"@site/api/namespaces/provider/functions/getProviderLifecycleContext.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"},next:{title:"onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-getproviderlifecyclecontext",children:"Function: getProviderLifecycleContext()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"getProviderLifecycleContext"}),"(",(0,r.jsx)(n.code,{children:"providerId"}),", ",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),"): ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"It returns the lifecycle context for the provider connection.\nIf no context is found it throws an error"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"the provider id"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.p,{children:"the connection to retrieve the lifecycle context for"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})}),"\n",(0,r.jsx)(n.p,{children:"the lifecycle context"}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsx)(n.p,{children:"if no provider with the id has been found or there is no context associate to it."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L598",children:"packages/extension-api/src/extension-api.d.ts:598"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var r=t(27378);const o={},i=r.createContext(o);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0fa6e9bf.de5ac8a0.js b/assets/js/0fa6e9bf.621301e3.js similarity index 80% rename from assets/js/0fa6e9bf.de5ac8a0.js rename to assets/js/0fa6e9bf.621301e3.js index 342aea3fc3e..e343432d5d1 100644 --- a/assets/js/0fa6e9bf.de5ac8a0.js +++ b/assets/js/0fa6e9bf.621301e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{7735:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=s(24246),r=s(71670);const o={},i="Function: openExternal()",c={id:"namespaces/env/functions/openExternal",title:"Function: openExternal()",description:"openExternal(uri): Promise\\",source:"@site/api/namespaces/env/functions/openExternal.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/openExternal",permalink:"/api/namespaces/env/functions/openExternal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3743",children:"packages/extension-api/src/extension-api.d.ts:3743"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var t=s(27378);const r={},o=t.createContext(r);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{7735:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=s(24246),r=s(71670);const o={},c="Function: openExternal()",i={id:"namespaces/env/functions/openExternal",title:"Function: openExternal()",description:"openExternal(uri): Promise\\",source:"@site/api/namespaces/env/functions/openExternal.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/openExternal",permalink:"/api/namespaces/env/functions/openExternal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-openexternal",children:"Function: openExternal()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"openExternal"}),"(",(0,t.jsx)(n.code,{children:"uri"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens a link externally using the default application. Depending on the"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"uri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,t.jsx)(n.p,{children:"A promise indicating if open was successful."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3743",children:"packages/extension-api/src/extension-api.d.ts:3743"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/107d77e6.d899bb94.js b/assets/js/107d77e6.c9e7fa9f.js similarity index 95% rename from assets/js/107d77e6.d899bb94.js rename to assets/js/107d77e6.c9e7fa9f.js index be5f9f23005..5cfc1cb4d84 100644 --- a/assets/js/107d77e6.d899bb94.js +++ b/assets/js/107d77e6.c9e7fa9f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{12585:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListInfosOptions",c={id:"interfaces/ListInfosOptions",title:"Interface: ListInfosOptions",description:"Properties",source:"@site/api/interfaces/ListInfosOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"},next:{title:"Logger",permalink:"/api/interfaces/Logger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listinfosoptions",children:"Interface: ListInfosOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3185",children:"packages/extension-api/src/extension-api.d.ts:3185"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{12585:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListInfosOptions",c={id:"interfaces/ListInfosOptions",title:"Interface: ListInfosOptions",description:"Properties",source:"@site/api/interfaces/ListInfosOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"},next:{title:"Logger",permalink:"/api/interfaces/Logger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listinfosoptions",children:"Interface: ListInfosOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the infos. If not provided, will return info for all engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3185",children:"packages/extension-api/src/extension-api.d.ts:3185"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/123a454a.16051de8.js b/assets/js/123a454a.4a51b70f.js similarity index 83% rename from assets/js/123a454a.16051de8.js rename to assets/js/123a454a.4a51b70f.js index a6177ca5cb8..78a80e9965a 100644 --- a/assets/js/123a454a.16051de8.js +++ b/assets/js/123a454a.4a51b70f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{16241:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>a});var s=t(24246),r=t(71670);const o={},c="Interface: RunResult",i={id:"interfaces/RunResult",title:"Interface: RunResult",description:"Represents the result of running a command.",source:"@site/api/interfaces/RunResult.md",sourceDirName:"interfaces",slug:"/interfaces/RunResult",permalink:"/api/interfaces/RunResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunOptions",permalink:"/api/interfaces/RunOptions"},next:{title:"SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-runresult",children:"Interface: RunResult"}),"\n",(0,s.jsx)(n.p,{children:"Represents the result of running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3802",children:"packages/extension-api/src/extension-api.d.ts:3802"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stderr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3812",children:"packages/extension-api/src/extension-api.d.ts:3812"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stdout"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3807",children:"packages/extension-api/src/extension-api.d.ts:3807"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var s=t(27378);const r={},o=s.createContext(r);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{16241:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var s=t(24246),r=t(71670);const c={},o="Interface: RunResult",i={id:"interfaces/RunResult",title:"Interface: RunResult",description:"Represents the result of running a command.",source:"@site/api/interfaces/RunResult.md",sourceDirName:"interfaces",slug:"/interfaces/RunResult",permalink:"/api/interfaces/RunResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunOptions",permalink:"/api/interfaces/RunOptions"},next:{title:"SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-1",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-runresult",children:"Interface: RunResult"}),"\n",(0,s.jsx)(n.p,{children:"Represents the result of running a command."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3802",children:"packages/extension-api/src/extension-api.d.ts:3802"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stderr"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3812",children:"packages/extension-api/src/extension-api.d.ts:3812"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stdout"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3807",children:"packages/extension-api/src/extension-api.d.ts:3807"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>o});var s=t(27378);const r={},c=s.createContext(r);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/125d93c1.b2e32dad.js b/assets/js/125d93c1.b2e32dad.js new file mode 100644 index 00000000000..1611cb921b2 --- /dev/null +++ b/assets/js/125d93c1.b2e32dad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{20333:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const i={},a="Function: navigateToPods()",c={id:"namespaces/navigation/functions/navigateToPods",title:"Function: navigateToPods()",description:"navigateToPods(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPods.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod"},next:{title:"navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"navigateToPods"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4203",children:"packages/extension-api/src/extension-api.d.ts:4203"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>a});var t=o(27378);const s={},i=t.createContext(s);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/125d93c1.cff8e12c.js b/assets/js/125d93c1.cff8e12c.js deleted file mode 100644 index 03a34215cd1..00000000000 --- a/assets/js/125d93c1.cff8e12c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{20333:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const a={},i="Function: navigateToPods()",c={id:"namespaces/navigation/functions/navigateToPods",title:"Function: navigateToPods()",description:"navigateToPods(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPods.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod"},next:{title:"navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-navigatetopods",children:"Function: navigateToPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"navigateToPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"}),"<",(0,t.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4203",children:"packages/extension-api/src/extension-api.d.ts:4203"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>c,a:()=>i});var t=o(27378);const s={},a=t.createContext(s);function i(n){const e=t.useContext(a);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:i(n.components),t.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/12eb386e.7bc7e2f7.js b/assets/js/12eb386e.926ba567.js similarity index 85% rename from assets/js/12eb386e.7bc7e2f7.js rename to assets/js/12eb386e.926ba567.js index 5162f64543d..91e09671ae8 100644 --- a/assets/js/12eb386e.7bc7e2f7.js +++ b/assets/js/12eb386e.926ba567.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{60804:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolOptions",c={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4040",children:"packages/extension-api/src/extension-api.d.ts:4040"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4042",children:"packages/extension-api/src/extension-api.d.ts:4042"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4041",children:"packages/extension-api/src/extension-api.d.ts:4041"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4052",children:"packages/extension-api/src/extension-api.d.ts:4052"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Within your extension, it is reccommended to implement your own functionality to check the current\nversion number of the CLI tool. For example, parsing the information from the CLI tool's ",(0,i.jsx)(n.code,{children:"--version"})," flag.\nPassing in path will also help to show where the CLI tool is expected to be installed.\nThis is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory.\nNote: The expected value should not include 'v'."]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4051",children:"packages/extension-api/src/extension-api.d.ts:4051"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{60804:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolOptions",c={id:"interfaces/CliToolOptions",title:"Interface: CliToolOptions",description:"Options to create new CliTool instance and register it in podman desktop",source:"@site/api/interfaces/CliToolOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolOptions",permalink:"/api/interfaces/CliToolOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliTool",permalink:"/api/interfaces/CliTool"},next:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-5",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitooloptions",children:"Interface: CliToolOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to create new CliTool instance and register it in podman desktop"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4040",children:"packages/extension-api/src/extension-api.d.ts:4040"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4042",children:"packages/extension-api/src/extension-api.d.ts:4042"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4041",children:"packages/extension-api/src/extension-api.d.ts:4041"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4052",children:"packages/extension-api/src/extension-api.d.ts:4052"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Within your extension, it is reccommended to implement your own functionality to check the current\nversion number of the CLI tool. For example, parsing the information from the CLI tool's ",(0,i.jsx)(n.code,{children:"--version"})," flag.\nPassing in path will also help to show where the CLI tool is expected to be installed.\nThis is usually the ~/.local/share/containers/podman-desktop/extensions-storage directory.\nNote: The expected value should not include 'v'."]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4051",children:"packages/extension-api/src/extension-api.d.ts:4051"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/148448cb.3d52975e.js b/assets/js/148448cb.94e20d50.js similarity index 87% rename from assets/js/148448cb.3d52975e.js rename to assets/js/148448cb.94e20d50.js index 04083e05421..b5dca979c62 100644 --- a/assets/js/148448cb.3d52975e.js +++ b/assets/js/148448cb.94e20d50.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{36129:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const o={},r="Interface: ContainerCreateOptions",d={id:"interfaces/ContainerCreateOptions",title:"Interface: ContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/ContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"},next:{title:"ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Source",id:"source",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Source",id:"source-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Source",id:"source-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Source",id:"source-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Source",id:"source-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Source",id:"source-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Source",id:"source-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-7",level:4},{value:"Env?",id:"env",level:3},{value:"Source",id:"source-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Source",id:"source-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Source",id:"source-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Source",id:"source-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Source",id:"source-13",level:4},{value:"Image?",id:"image",level:3},{value:"Source",id:"source-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Source",id:"source-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Source",id:"source-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Source",id:"source-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Source",id:"source-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Source",id:"source-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Source",id:"source-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Source",id:"source-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Source",id:"source-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Source",id:"source-25",level:4},{value:"User?",id:"user",level:3},{value:"Source",id:"source-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Source",id:"source-28",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-31",level:4},{value:"start?",id:"start",level:3},{value:"Source",id:"source-32",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2729",children:"packages/extension-api/src/extension-api.d.ts:2729"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2697",children:"packages/extension-api/src/extension-api.d.ts:2697"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2687",children:"packages/extension-api/src/extension-api.d.ts:2687"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2692",children:"packages/extension-api/src/extension-api.d.ts:2692"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2675",children:"packages/extension-api/src/extension-api.d.ts:2675"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Detach"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2712",children:"packages/extension-api/src/extension-api.d.ts:2712"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2629",children:"packages/extension-api/src/extension-api.d.ts:2629"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,i.jsx)(n.code,{children:'[""]'}),") then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile)."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2682",children:"packages/extension-api/src/extension-api.d.ts:2682"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"Env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,i.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,i.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2639",children:"packages/extension-api/src/extension-api.d.ts:2639"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"envfiles",children:"EnvFiles?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EnvFiles"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2644",children:"packages/extension-api/src/extension-api.d.ts:2644"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,i.jsx)(n.code,{children:'{"/": {}}'})]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"port"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2655",children:"packages/extension-api/src/extension-api.d.ts:2655"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HealthCheck"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,i.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2722",children:"packages/extension-api/src/extension-api.d.ts:2722"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2660",children:"packages/extension-api/src/extension-api.d.ts:2660"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2624",children:"packages/extension-api/src/extension-api.d.ts:2624"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2649",children:"packages/extension-api/src/extension-api.d.ts:2649"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2749",children:"packages/extension-api/src/extension-api.d.ts:2749"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,i.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2773",children:"packages/extension-api/src/extension-api.d.ts:2773"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2744",children:"packages/extension-api/src/extension-api.d.ts:2744"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,i.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2754",children:"packages/extension-api/src/extension-api.d.ts:2754"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to open ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2702",children:"packages/extension-api/src/extension-api.d.ts:2702"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Shell"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Shell for when ",(0,i.jsx)(n.code,{children:"RUN"}),", ",(0,i.jsx)(n.code,{children:"CMD"}),", and ",(0,i.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2771",children:"packages/extension-api/src/extension-api.d.ts:2771"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Close ",(0,i.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2707",children:"packages/extension-api/src/extension-api.d.ts:2707"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StopSignal"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StopTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"10"})]}),"\n",(0,i.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2766",children:"packages/extension-api/src/extension-api.d.ts:2766"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2670",children:"packages/extension-api/src/extension-api.d.ts:2670"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"user",children:"User?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2634",children:"packages/extension-api/src/extension-api.d.ts:2634"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2734",children:"packages/extension-api/src/extension-api.d.ts:2734"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,i.jsx)(n.code,{children:"/?[a-zA-Z0-9][a-zA-Z0-9_.-]+"}),". If not speficied, the platform assigns a unique name to the container"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2602",children:"packages/extension-api/src/extension-api.d.ts:2602"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsxs)(n.p,{children:["Platform in the format ",(0,i.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,i.jsxs)(n.p,{children:["When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a ",(0,i.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,i.jsxs)(n.p,{children:["If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the ",(0,i.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"WARNING: The requested image's platform (linux/arm64/v8) does not\n match the detected host platform (linux/amd64) and no\n specific platform was requested\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2619",children:"packages/extension-api/src/extension-api.d.ts:2619"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2778",children:"packages/extension-api/src/extension-api.d.ts:2778"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"start",children:"start?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"start"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2717",children:"packages/extension-api/src/extension-api.d.ts:2717"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{36129:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const o={},r="Interface: ContainerCreateOptions",t={id:"interfaces/ContainerCreateOptions",title:"Interface: ContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/ContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"},next:{title:"ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"ArgsEscaped?",id:"argsescaped",level:3},{value:"Source",id:"source",level:4},{value:"AttachStderr?",id:"attachstderr",level:3},{value:"Source",id:"source-1",level:4},{value:"AttachStdin?",id:"attachstdin",level:3},{value:"Source",id:"source-2",level:4},{value:"AttachStdout?",id:"attachstdout",level:3},{value:"Source",id:"source-3",level:4},{value:"Cmd?",id:"cmd",level:3},{value:"Source",id:"source-4",level:4},{value:"Detach?",id:"detach",level:3},{value:"Source",id:"source-5",level:4},{value:"Domainname?",id:"domainname",level:3},{value:"Source",id:"source-6",level:4},{value:"Entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-7",level:4},{value:"Env?",id:"env",level:3},{value:"Source",id:"source-8",level:4},{value:"EnvFiles?",id:"envfiles",level:3},{value:"Source",id:"source-9",level:4},{value:"ExposedPorts?",id:"exposedports",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-10",level:4},{value:"HealthCheck?",id:"healthcheck",level:3},{value:"Source",id:"source-11",level:4},{value:"HostConfig?",id:"hostconfig",level:3},{value:"Source",id:"source-12",level:4},{value:"Hostname?",id:"hostname",level:3},{value:"Source",id:"source-13",level:4},{value:"Image?",id:"image",level:3},{value:"Source",id:"source-14",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-15",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-16",level:4},{value:"NetworkConfig?",id:"networkconfig",level:3},{value:"Source",id:"source-17",level:4},{value:"NetworkDisabled?",id:"networkdisabled",level:3},{value:"Source",id:"source-18",level:4},{value:"OnBuild?",id:"onbuild",level:3},{value:"Source",id:"source-19",level:4},{value:"OpenStdin?",id:"openstdin",level:3},{value:"Source",id:"source-20",level:4},{value:"Shell?",id:"shell",level:3},{value:"Source",id:"source-21",level:4},{value:"StdinOnce?",id:"stdinonce",level:3},{value:"Source",id:"source-22",level:4},{value:"StopSignal?",id:"stopsignal",level:3},{value:"Source",id:"source-23",level:4},{value:"StopTimeout?",id:"stoptimeout",level:3},{value:"Source",id:"source-24",level:4},{value:"Tty?",id:"tty",level:3},{value:"Source",id:"source-25",level:4},{value:"User?",id:"user",level:3},{value:"Source",id:"source-26",level:4},{value:"Volumes?",id:"volumes",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-27",level:4},{value:"WorkingDir?",id:"workingdir",level:3},{value:"Source",id:"source-28",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-29",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-30",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-31",level:4},{value:"start?",id:"start",level:3},{value:"Source",id:"source-32",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateoptions",children:"Interface: ContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"argsescaped",children:"ArgsEscaped?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"Command is already escaped (Windows only)"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2729",children:"packages/extension-api/src/extension-api.d.ts:2729"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstderr",children:"AttachStderr?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stderr"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2697",children:"packages/extension-api/src/extension-api.d.ts:2697"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdin",children:"AttachStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2687",children:"packages/extension-api/src/extension-api.d.ts:2687"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"attachstdout",children:"AttachStdout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to attach to ",(0,i.jsx)(n.code,{children:"stdout"}),"(default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2692",children:"packages/extension-api/src/extension-api.d.ts:2692"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cmd",children:"Cmd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Command to run specified as an array of strings"}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2675",children:"packages/extension-api/src/extension-api.d.ts:2675"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"detach",children:"Detach?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Detach"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Run the container in the background"}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2712",children:"packages/extension-api/src/extension-api.d.ts:2712"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"domainname",children:"Domainname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The domain name to use for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2629",children:"packages/extension-api/src/extension-api.d.ts:2629"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The entry point for the container as a string or an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["If the array consists of exactly one empty string (",(0,i.jsx)(n.code,{children:'[""]'}),") then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Containerfile)."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2682",children:"packages/extension-api/src/extension-api.d.ts:2682"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"Env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A list of environment variables to set inside the container in the form ",(0,i.jsx)(n.code,{children:'["VAR=value", ...]'}),". A variable without ",(0,i.jsx)(n.code,{children:"="})," is removed from the environment, rather than to have an empty value"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2639",children:"packages/extension-api/src/extension-api.d.ts:2639"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"envfiles",children:"EnvFiles?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EnvFiles"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment files to use"}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2644",children:"packages/extension-api/src/extension-api.d.ts:2644"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"exposedports",children:"ExposedPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An object mapping ports to an empty object in the form: ",(0,i.jsx)(n.code,{children:'{"/": {}}'})]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"port"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2655",children:"packages/extension-api/src/extension-api.d.ts:2655"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"healthcheck",children:"HealthCheck?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HealthCheck"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:(0,i.jsx)(n.code,{children:"HealthConfig"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["A test to perform to check that the container is healthy. See ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthConfig",children:"HealthConfig"})," for usage details"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2722",children:"packages/extension-api/src/extension-api.d.ts:2722"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Container configuration that depends on the host we are running on"}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2660",children:"packages/extension-api/src/extension-api.d.ts:2660"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"Hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The hostname to use for the container, as a valid RFC 1123 hostname"}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2624",children:"packages/extension-api/src/extension-api.d.ts:2624"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The name (or reference) of the image to use when creating the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2665",children:"packages/extension-api/src/extension-api.d.ts:2665"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"User-defined key/value metadata"}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2649",children:"packages/extension-api/src/extension-api.d.ts:2649"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address of the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2749",children:"packages/extension-api/src/extension-api.d.ts:2749"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkconfig",children:"NetworkConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkingConfig",children:(0,i.jsx)(n.code,{children:"NetworkingConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2773",children:"packages/extension-api/src/extension-api.d.ts:2773"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkdisabled",children:"NetworkDisabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkDisabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Disable networking for the container."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2744",children:"packages/extension-api/src/extension-api.d.ts:2744"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"ONBUILD"})," metadata that were defined in the image's ",(0,i.jsx)(n.code,{children:"Dockerfile"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2754",children:"packages/extension-api/src/extension-api.d.ts:2754"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"openstdin",children:"OpenStdin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Whether to open ",(0,i.jsx)(n.code,{children:"stdin"})," (default false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2702",children:"packages/extension-api/src/extension-api.d.ts:2702"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shell",children:"Shell?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Shell"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Shell for when ",(0,i.jsx)(n.code,{children:"RUN"}),", ",(0,i.jsx)(n.code,{children:"CMD"}),", and ",(0,i.jsx)(n.code,{children:"ENTRYPOINT"})," uses a shell."]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2771",children:"packages/extension-api/src/extension-api.d.ts:2771"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stdinonce",children:"StdinOnce?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Close ",(0,i.jsx)(n.code,{children:"stdin"})," after one attached client disconnects (deafult false)"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2707",children:"packages/extension-api/src/extension-api.d.ts:2707"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stopsignal",children:"StopSignal?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StopSignal"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Signal to stop a container as a string or unsigned integer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2759",children:"packages/extension-api/src/extension-api.d.ts:2759"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"stoptimeout",children:"StopTimeout?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StopTimeout"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Default: ",(0,i.jsx)(n.code,{children:"10"})]}),"\n",(0,i.jsx)(n.p,{children:"Timeout to stop a container in seconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2766",children:"packages/extension-api/src/extension-api.d.ts:2766"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tty",children:"Tty?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attach standard streams to a TTY, including stdin if it is not closed (default false)"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2670",children:"packages/extension-api/src/extension-api.d.ts:2670"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"user",children:"User?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The user that commands are run as inside the container"}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2634",children:"packages/extension-api/src/extension-api.d.ts:2634"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An object mapping mount point paths inside the container to empty objects."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2734",children:"packages/extension-api/src/extension-api.d.ts:2734"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"workingdir",children:"WorkingDir?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The working directory for commands to run in."}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2739",children:"packages/extension-api/src/extension-api.d.ts:2739"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Assign the specified name to the container. Must match the regular expression",(0,i.jsx)(n.code,{children:"/?[a-zA-Z0-9][a-zA-Z0-9_.-]+"}),". If not speficied, the platform assigns a unique name to the container"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2602",children:"packages/extension-api/src/extension-api.d.ts:2602"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsxs)(n.p,{children:["Platform in the format ",(0,i.jsx)(n.code,{children:"os[/arch[/variant]]"})," used for image lookup."]}),"\n",(0,i.jsxs)(n.p,{children:["When specified, the daemon checks if the requested image is present in the local image cache with the given OS and Architecture, and otherwise returns a ",(0,i.jsx)(n.code,{children:"404"})," status."]}),"\n",(0,i.jsxs)(n.p,{children:["If the option is not set, the host's native OS and Architecture are used to look up the image in the image cache. However, if no platform is passed and the given image does exist in the local image cache, but its OS or architecture does not match, the container is created with the available image, and a warning is added to the ",(0,i.jsx)(n.code,{children:"Warnings"})," field in the response, for example;"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"WARNING: The requested image's platform (linux/arm64/v8) does not\n match the detected host platform (linux/amd64) and no\n specific platform was requested\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2619",children:"packages/extension-api/src/extension-api.d.ts:2619"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Pod where to create the container in"}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2778",children:"packages/extension-api/src/extension-api.d.ts:2778"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"start",children:"start?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"start"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Start the container immediately (default true)"}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2717",children:"packages/extension-api/src/extension-api.d.ts:2717"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/14ae68e7.46e2251c.js b/assets/js/14ae68e7.5f714ab6.js similarity index 91% rename from assets/js/14ae68e7.46e2251c.js rename to assets/js/14ae68e7.5f714ab6.js index 0278e5f8774..5aaf132c0bb 100644 --- a/assets/js/14ae68e7.46e2251c.js +++ b/assets/js/14ae68e7.5f714ab6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{41698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Interface: EndpointIPAMConfig",c={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Source",id:"source",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Source",id:"source-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LinkLocalIPs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{41698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Interface: EndpointIPAMConfig",c={id:"interfaces/EndpointIPAMConfig",title:"Interface: EndpointIPAMConfig",description:"Properties",source:"@site/api/interfaces/EndpointIPAMConfig.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"},next:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"IPv4Address?",id:"ipv4address",level:3},{value:"Source",id:"source",level:4},{value:"IPv6Address?",id:"ipv6address",level:3},{value:"Source",id:"source-1",level:4},{value:"LinkLocalIPs?",id:"linklocalips",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointipamconfig",children:"Interface: EndpointIPAMConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"linklocalips",children:"LinkLocalIPs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LinkLocalIPs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1515c895.b5f7936a.js b/assets/js/1515c895.6df5ef78.js similarity index 83% rename from assets/js/1515c895.b5f7936a.js rename to assets/js/1515c895.6df5ef78.js index b4cfe7350fc..5005717107a 100644 --- a/assets/js/1515c895.b5f7936a.js +++ b/assets/js/1515c895.6df5ef78.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{16742:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const s={},o="Function: navigateToImage()",r={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,i.jsx)(n.code,{children:"id"}),", ",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"tag"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4195",children:"packages/extension-api/src/extension-api.d.ts:4195"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>o});var i=t(27378);const a={},s=i.createContext(a);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{16742:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>g,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const s={},o="Function: navigateToImage()",c={id:"namespaces/navigation/functions/navigateToImage",title:"Function: navigateToImage()",description:"navigateToImage(id, engineId, tag): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImage.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"},next:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-navigatetoimage",children:"Function: navigateToImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToImage"}),"(",(0,i.jsx)(n.code,{children:"id"}),", ",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"tag"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4195",children:"packages/extension-api/src/extension-api.d.ts:4195"})})]})}function g(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const a={},s=i.createContext(a);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/160cb329.403f7889.js b/assets/js/160cb329.5d4d4827.js similarity index 91% rename from assets/js/160cb329.403f7889.js rename to assets/js/160cb329.5d4d4827.js index 14e2f30ebfc..b2e4f96916a 100644 --- a/assets/js/160cb329.403f7889.js +++ b/assets/js/160cb329.5d4d4827.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{43996:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(24246),s=t(71670);const i={},c="Interface: ProviderDetectionCheck",o={id:"interfaces/ProviderDetectionCheck",title:"Interface: ProviderDetectionCheck",description:"Properties",source:"@site/api/interfaces/ProviderDetectionCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"},next:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"details"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L231",children:"packages/extension-api/src/extension-api.d.ts:231"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L230",children:"packages/extension-api/src/extension-api.d.ts:230"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L232",children:"packages/extension-api/src/extension-api.d.ts:232"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var r=t(27378);const s={},i=r.createContext(s);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{43996:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=t(24246),s=t(71670);const i={},c="Interface: ProviderDetectionCheck",o={id:"interfaces/ProviderDetectionCheck",title:"Interface: ProviderDetectionCheck",description:"Properties",source:"@site/api/interfaces/ProviderDetectionCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"},next:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerdetectioncheck",children:"Interface: ProviderDetectionCheck"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"details"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L231",children:"packages/extension-api/src/extension-api.d.ts:231"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L230",children:"packages/extension-api/src/extension-api.d.ts:230"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L232",children:"packages/extension-api/src/extension-api.d.ts:232"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var r=t(27378);const s={},i=r.createContext(s);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/164937d2.639bf952.js b/assets/js/164937d2.e76ebb0f.js similarity index 93% rename from assets/js/164937d2.639bf952.js rename to assets/js/164937d2.e76ebb0f.js index 27ab1c0e07a..7385f846c73 100644 --- a/assets/js/164937d2.639bf952.js +++ b/assets/js/164937d2.e76ebb0f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{1499:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: SecretStorage",d={id:"interfaces/SecretStorage",title:"Interface: SecretStorage",description:"Represents a storage utility for secrets, information that is",source:"@site/api/interfaces/SecretStorage.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorage",permalink:"/api/interfaces/SecretStorage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"},next:{title:"SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-secretstorage",children:"Interface: SecretStorage"}),"\n",(0,s.jsx)(n.p,{children:"Represents a storage utility for secrets, information that is\nsensitive."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChange"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorageChangeEvent",children:(0,s.jsx)(n.code,{children:"SecretStorageChangeEvent"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fires when a secret is stored or deleted."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4272",children:"packages/extension-api/src/extension-api.d.ts:4272"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Remove a secret from storage."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4267",children:"packages/extension-api/src/extension-api.d.ts:4267"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Retrieve a secret that was stored with key. Returns undefined if there\nis no secret matching that key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["The stored value or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"store",children:"store()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"store"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Store a secret under a given key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to store the secret under."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The secret."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4261",children:"packages/extension-api/src/extension-api.d.ts:4261"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{1499:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: SecretStorage",d={id:"interfaces/SecretStorage",title:"Interface: SecretStorage",description:"Represents a storage utility for secrets, information that is",source:"@site/api/interfaces/SecretStorage.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorage",permalink:"/api/interfaces/SecretStorage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions"},next:{title:"SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"store()",id:"store",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-secretstorage",children:"Interface: SecretStorage"}),"\n",(0,s.jsx)(n.p,{children:"Represents a storage utility for secrets, information that is\nsensitive."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onDidChange"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/SecretStorageChangeEvent",children:(0,s.jsx)(n.code,{children:"SecretStorageChangeEvent"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Fires when a secret is stored or deleted."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4272",children:"packages/extension-api/src/extension-api.d.ts:4272"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Remove a secret from storage."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4267",children:"packages/extension-api/src/extension-api.d.ts:4267"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"get"}),"(",(0,s.jsx)(n.code,{children:"key"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Retrieve a secret that was stored with key. Returns undefined if there\nis no secret matching that key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key the secret was stored under."}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:["The stored value or ",(0,s.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"store",children:"store()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"store"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Store a secret under a given key."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The key to store the secret under."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The secret."}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4261",children:"packages/extension-api/src/extension-api.d.ts:4261"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/16914cba.8710f06b.js b/assets/js/16914cba.cf84919d.js similarity index 98% rename from assets/js/16914cba.8710f06b.js rename to assets/js/16914cba.cf84919d.js index c0b60788ae1..a3ca80bf357 100644 --- a/assets/js/16914cba.8710f06b.js +++ b/assets/js/16914cba.cf84919d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{26293:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: deleteContainer()",c={id:"namespaces/containerEngine/functions/deleteContainer",title:"Function: deleteContainer()",description:"deleteContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume"},next:{title:"deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3282",children:"packages/extension-api/src/extension-api.d.ts:3282"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{26293:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: deleteContainer()",c={id:"namespaces/containerEngine/functions/deleteContainer",title:"Function: deleteContainer()",description:"deleteContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume"},next:{title:"deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deletecontainer",children:"Function: deleteContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete an existing container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3282",children:"packages/extension-api/src/extension-api.d.ts:3282"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17612ae7.1d76b44f.js b/assets/js/17612ae7.48208848.js similarity index 87% rename from assets/js/17612ae7.1d76b44f.js rename to assets/js/17612ae7.48208848.js index 5bdb6da363e..83b94672f98 100644 --- a/assets/js/17612ae7.1d76b44f.js +++ b/assets/js/17612ae7.48208848.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{68278:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const r={},c="Function: deleteImage()",o={id:"namespaces/containerEngine/functions/deleteImage",title:"Function: deleteImage()",description:"deleteImage(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"},next:{title:"deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3370",children:"packages/extension-api/src/extension-api.d.ts:3370"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{68278:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const c={},r="Function: deleteImage()",o={id:"namespaces/containerEngine/functions/deleteImage",title:"Function: deleteImage()",description:"deleteImage(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"},next:{title:"deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-deleteimage",children:"Function: deleteImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"deleteImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Delete a container image from a local engine"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3370",children:"packages/extension-api/src/extension-api.d.ts:3370"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/17d2ebc8.a6c790df.js b/assets/js/17d2ebc8.9af76bf5.js similarity index 78% rename from assets/js/17d2ebc8.a6c790df.js rename to assets/js/17d2ebc8.9af76bf5.js index a9712a7c398..f34a23c98d9 100644 --- a/assets/js/17d2ebc8.a6c790df.js +++ b/assets/js/17d2ebc8.9af76bf5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{75450:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="Interface: ContainerJSONEvent",c={id:"interfaces/ContainerJSONEvent",title:"Interface: ContainerJSONEvent",description:"Properties",source:"@site/api/interfaces/ContainerJSONEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"},next:{title:"ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type-1",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"Type?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2406",children:"packages/extension-api/src/extension-api.d.ts:2406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2404",children:"packages/extension-api/src/extension-api.d.ts:2404"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"type-1",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2403",children:"packages/extension-api/src/extension-api.d.ts:2403"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{75450:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="Interface: ContainerJSONEvent",o={id:"interfaces/ContainerJSONEvent",title:"Interface: ContainerJSONEvent",description:"Properties",source:"@site/api/interfaces/ContainerJSONEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"},next:{title:"ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Type?",id:"type",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type-1",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerjsonevent",children:"Interface: ContainerJSONEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"type",children:"Type?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"Type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2406",children:"packages/extension-api/src/extension-api.d.ts:2406"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2405",children:"packages/extension-api/src/extension-api.d.ts:2405"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2404",children:"packages/extension-api/src/extension-api.d.ts:2404"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"type-1",children:"type"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2403",children:"packages/extension-api/src/extension-api.d.ts:2403"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/180d0c5f.4d5a0b38.js b/assets/js/180d0c5f.de31f6e9.js similarity index 83% rename from assets/js/180d0c5f.4d5a0b38.js rename to assets/js/180d0c5f.de31f6e9.js index 6474280802d..ddadcf14263 100644 --- a/assets/js/180d0c5f.4d5a0b38.js +++ b/assets/js/180d0c5f.de31f6e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{93302:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",a={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},c={},h=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3547",children:"packages/extension-api/src/extension-api.d.ts:3547"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{93302:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>h});var i=t(24246),s=t(71670);const o={},r="Interface: AuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationSessionsChangeEvent",title:"Interface: AuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"},next:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"}},a={},h=[{value:"Properties",id:"properties",level:2},{value:"provider",id:"provider",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionschangeevent",children:"Interface: AuthenticationSessionsChangeEvent"}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationProviderInformation"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})," that has had its sessions change."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3547",children:"packages/extension-api/src/extension-api.d.ts:3547"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/185c52e7.f693b684.js b/assets/js/185c52e7.a7b700dd.js similarity index 89% rename from assets/js/185c52e7.f693b684.js rename to assets/js/185c52e7.a7b700dd.js index 1e16bf0c9ec..ec859e5dc55 100644 --- a/assets/js/185c52e7.f693b684.js +++ b/assets/js/185c52e7.a7b700dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{89425:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: VolumeCreateResponseInfo",o={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3173",children:"packages/extension-api/src/extension-api.d.ts:3173"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3171",children:"packages/extension-api/src/extension-api.d.ts:3171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3175",children:"packages/extension-api/src/extension-api.d.ts:3175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3172",children:"packages/extension-api/src/extension-api.d.ts:3172"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3170",children:"packages/extension-api/src/extension-api.d.ts:3170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3174",children:"packages/extension-api/src/extension-api.d.ts:3174"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{89425:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: VolumeCreateResponseInfo",o={id:"interfaces/VolumeCreateResponseInfo",title:"Interface: VolumeCreateResponseInfo",description:"Properties",source:"@site/api/interfaces/VolumeCreateResponseInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"},next:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt?",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-5",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3173",children:"packages/extension-api/src/extension-api.d.ts:3173"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3171",children:"packages/extension-api/src/extension-api.d.ts:3171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3175",children:"packages/extension-api/src/extension-api.d.ts:3175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3172",children:"packages/extension-api/src/extension-api.d.ts:3172"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3170",children:"packages/extension-api/src/extension-api.d.ts:3170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3176",children:"packages/extension-api/src/extension-api.d.ts:3176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3174",children:"packages/extension-api/src/extension-api.d.ts:3174"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/19e69ccd.65e227f4.js b/assets/js/19e69ccd.c21063ce.js similarity index 78% rename from assets/js/19e69ccd.65e227f4.js rename to assets/js/19e69ccd.c21063ce.js index c4e19a177f3..22da573f66a 100644 --- a/assets/js/19e69ccd.65e227f4.js +++ b/assets/js/19e69ccd.c21063ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{73122:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Interface: CPUStats",a={id:"interfaces/CPUStats",title:"Interface: CPUStats",description:"Properties",source:"@site/api/interfaces/CPUStats.md",sourceDirName:"interfaces",slug:"/interfaces/CPUStats",permalink:"/api/interfaces/CPUStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"},next:{title:"CPUUsage",permalink:"/api/interfaces/CPUUsage"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Source",id:"source-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,t.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2900",children:"packages/extension-api/src/extension-api.d.ts:2900"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"online_cpus"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"throttling_data"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,t.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2903",children:"packages/extension-api/src/extension-api.d.ts:2903"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{73122:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=s(24246),c=s(71670);const i={},r="Interface: CPUStats",a={id:"interfaces/CPUStats",title:"Interface: CPUStats",description:"Properties",source:"@site/api/interfaces/CPUStats.md",sourceDirName:"interfaces",slug:"/interfaces/CPUStats",permalink:"/api/interfaces/CPUStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"},next:{title:"CPUUsage",permalink:"/api/interfaces/CPUUsage"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"cpu_usage",id:"cpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"online_cpus",id:"online_cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"system_cpu_usage",id:"system_cpu_usage",level:3},{value:"Source",id:"source-2",level:4},{value:"throttling_data",id:"throttling_data",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-cpustats",children:"Interface: CPUStats"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"cpu_usage",children:"cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"cpu_usage"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CPUUsage",children:(0,t.jsx)(n.code,{children:"CPUUsage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2900",children:"packages/extension-api/src/extension-api.d.ts:2900"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"online_cpus",children:"online_cpus"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"online_cpus"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"system_cpu_usage",children:"system_cpu_usage"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"system_cpu_usage"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"throttling_data",children:"throttling_data"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"throttling_data"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ThrottlingData",children:(0,t.jsx)(n.code,{children:"ThrottlingData"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2903",children:"packages/extension-api/src/extension-api.d.ts:2903"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var t=s(27378);const c={},i=t.createContext(c);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a906644.727c5ca3.js b/assets/js/1a906644.a6b73d9a.js similarity index 86% rename from assets/js/1a906644.727c5ca3.js rename to assets/js/1a906644.a6b73d9a.js index 01a354bf89c..f17f1473be9 100644 --- a/assets/js/1a906644.727c5ca3.js +++ b/assets/js/1a906644.a6b73d9a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{34480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="Function: createManifest()",o={id:"namespaces/containerEngine/functions/createManifest",title:"Function: createManifest()",description:"createManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer"},next:{title:"createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createManifest"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,s.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3425",children:"packages/extension-api/src/extension-api.d.ts:3425"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{34480:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Function: createManifest()",o={id:"namespaces/containerEngine/functions/createManifest",title:"Function: createManifest()",description:"createManifest(options): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer"},next:{title:"createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createmanifest",children:"Function: createManifest()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createManifest"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/ManifestCreateOptions",children:(0,s.jsx)(n.code,{children:"ManifestCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3425",children:"packages/extension-api/src/extension-api.d.ts:3425"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1dfee34e.26922457.js b/assets/js/1dfee34e.820d13fd.js similarity index 93% rename from assets/js/1dfee34e.26922457.js rename to assets/js/1dfee34e.820d13fd.js index 1ee5f44788b..c7323630404 100644 --- a/assets/js/1dfee34e.26922457.js +++ b/assets/js/1dfee34e.820d13fd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{36729:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var c=s(24246),o=s(71670);const i={},r="Class: CancellationTokenSource",t={id:"classes/CancellationTokenSource",title:"Class: CancellationTokenSource",description:"Constructors",source:"@site/api/classes/CancellationTokenSource.md",sourceDirName:"classes",slug:"/classes/CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"},next:{title:"Disposable",permalink:"/api/classes/Disposable"}},l={},a=[{value:"Constructors",id:"constructors",level:2},{value:"new CancellationTokenSource()",id:"new-cancellationtokensource",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"token",id:"token",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"}),"\n",(0,c.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,c.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"token",children:"token"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"token"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The cancellation token of this source."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L833",children:"packages/extension-api/src/extension-api.d.ts:833"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"cancel"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Signal cancellation on the token."}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L838",children:"packages/extension-api/src/extension-api.d.ts:838"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"dispose"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Dispose object and free resources."}),"\n",(0,c.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L843",children:"packages/extension-api/src/extension-api.d.ts:843"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const o={},i=c.createContext(o);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{36729:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var c=s(24246),o=s(71670);const i={},r="Class: CancellationTokenSource",t={id:"classes/CancellationTokenSource",title:"Class: CancellationTokenSource",description:"Constructors",source:"@site/api/classes/CancellationTokenSource.md",sourceDirName:"classes",slug:"/classes/CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"},next:{title:"Disposable",permalink:"/api/classes/Disposable"}},l={},a=[{value:"Constructors",id:"constructors",level:2},{value:"new CancellationTokenSource()",id:"new-cancellationtokensource",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"token",id:"token",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"cancel()",id:"cancel",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"}),"\n",(0,c.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,c.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,c.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"token",children:"token"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"token"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The cancellation token of this source."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L833",children:"packages/extension-api/src/extension-api.d.ts:833"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"cancel"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Signal cancellation on the token."}),"\n",(0,c.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L838",children:"packages/extension-api/src/extension-api.d.ts:838"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"dispose"}),"(): ",(0,c.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Dispose object and free resources."}),"\n",(0,c.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"void"})}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L843",children:"packages/extension-api/src/extension-api.d.ts:843"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var c=s(27378);const o={},i=c.createContext(o);function r(e){const n=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),c.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ee92283.5e32c094.js b/assets/js/1ee92283.60ab481f.js similarity index 91% rename from assets/js/1ee92283.5e32c094.js rename to assets/js/1ee92283.60ab481f.js index fc6ee5d3e73..d6a75bc73a0 100644 --- a/assets/js/1ee92283.5e32c094.js +++ b/assets/js/1ee92283.60ab481f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{83663:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var r=s(24246),i=s(71670);const c={},d="Interface: Provider",t={id:"interfaces/Provider",title:"Interface: Provider",description:"Properties",source:"@site/api/interfaces/Provider.md",sourceDirName:"interfaces",slug:"/interfaces/Provider",permalink:"/api/interfaces/Provider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProgressOptions",permalink:"/api/interfaces/ProgressOptions"},next:{title:"ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"links",id:"links",level:3},{value:"Source",id:"source-3",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-7",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-8",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Source",id:"source-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Source",id:"source-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Source",id:"source-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Source",id:"source-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Source",id:"source-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Source",id:"source-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Source",id:"source-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Source",id:"source-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Source",id:"source-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Source",id:"source-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"images"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,r.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L500",children:"packages/extension-api/src/extension-api.d.ts:500"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"links",children:"links"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"links"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,r.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L502",children:"packages/extension-api/src/extension-api.d.ts:502"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L489",children:"packages/extension-api/src/extension-api.d.ts:489"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})})," <",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"<",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L498",children:"packages/extension-api/src/extension-api.d.ts:498"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L491",children:"packages/extension-api/src/extension-api.d.ts:491"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warnings",children:"warnings"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L512",children:"packages/extension-api/src/extension-api.d.ts:512"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"dispose"}),"(): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L488",children:"packages/extension-api/src/extension-api.d.ts:488"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,r.jsx)(n.code,{children:"autostart"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"autostart"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,r.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,r.jsx)(n.code,{children:"cleanup"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cleanup"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,r.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L473",children:"packages/extension-api/src/extension-api.d.ts:473"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,r.jsx)(n.code,{children:"installation"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"installation"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,r.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L474",children:"packages/extension-api/src/extension-api.d.ts:474"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,r.jsx)(n.code,{children:"lifecycle"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,r.jsx)(n.code,{children:"update"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"update"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,r.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L481",children:"packages/extension-api/src/extension-api.d.ts:481"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,r.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateStatus"}),"(",(0,r.jsx)(n.code,{children:"status"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L492",children:"packages/extension-api/src/extension-api.d.ts:492"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateVersion"}),"(",(0,r.jsx)(n.code,{children:"version"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L497",children:"packages/extension-api/src/extension-api.d.ts:497"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,r.jsx)(n.code,{children:"warnings"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L513",children:"packages/extension-api/src/extension-api.d.ts:513"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{83663:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var r=s(24246),i=s(71670);const c={},d="Interface: Provider",t={id:"interfaces/Provider",title:"Interface: Provider",description:"Properties",source:"@site/api/interfaces/Provider.md",sourceDirName:"interfaces",slug:"/interfaces/Provider",permalink:"/api/interfaces/Provider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProgressOptions",permalink:"/api/interfaces/ProgressOptions"},next:{title:"ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"links",id:"links",level:3},{value:"Source",id:"source-3",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"onDidUpdateDetectionChecks",id:"ondidupdatedetectionchecks",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateStatus",id:"ondidupdatestatus",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-7",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-8",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-9",level:4},{value:"warnings",id:"warnings",level:3},{value:"Source",id:"source-10",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-11",level:4},{value:"registerAutostart()",id:"registerautostart",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-12",level:4},{value:"registerCleanup()",id:"registercleanup",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-13",level:4},{value:"registerContainerProviderConnection()",id:"registercontainerproviderconnection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-14",level:4},{value:"registerInstallation()",id:"registerinstallation",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-15",level:4},{value:"registerKubernetesProviderConnection()",id:"registerkubernetesproviderconnection",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Source",id:"source-16",level:4},{value:"registerLifecycle()",id:"registerlifecycle",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Source",id:"source-17",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Source",id:"source-18",level:4},{value:"setContainerProviderConnectionFactory()",id:"setcontainerproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Source",id:"source-19",level:4},{value:"setKubernetesProviderConnectionFactory()",id:"setkubernetesproviderconnectionfactory",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Source",id:"source-20",level:4},{value:"updateDetectionChecks()",id:"updatedetectionchecks",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Source",id:"source-21",level:4},{value:"updateStatus()",id:"updatestatus",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Source",id:"source-22",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Source",id:"source-23",level:4},{value:"updateWarnings()",id:"updatewarnings",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Source",id:"source-24",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-provider",children:"Interface: Provider"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L505",children:"packages/extension-api/src/extension-api.d.ts:505"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"images"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,r.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L500",children:"packages/extension-api/src/extension-api.d.ts:500"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"links",children:"links"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"links"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,r.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L502",children:"packages/extension-api/src/extension-api.d.ts:502"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L489",children:"packages/extension-api/src/extension-api.d.ts:489"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatedetectionchecks",children:"onDidUpdateDetectionChecks"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateDetectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdatestatus",children:"onDidUpdateStatus"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateStatus"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})})," <",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L493",children:"packages/extension-api/src/extension-api.d.ts:493"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"onDidUpdateVersion"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,r.jsx)(n.code,{children:"Event"})}),"<",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L498",children:"packages/extension-api/src/extension-api.d.ts:498"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L491",children:"packages/extension-api/src/extension-api.d.ts:491"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warnings",children:"warnings"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L512",children:"packages/extension-api/src/extension-api.d.ts:512"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"dispose"}),"(): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L488",children:"packages/extension-api/src/extension-api.d.ts:488"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerautostart",children:"registerAutostart()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAutostart"}),"(",(0,r.jsx)(n.code,{children:"autostart"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"autostart"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderAutostart",children:(0,r.jsx)(n.code,{children:"ProviderAutostart"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercleanup",children:"registerCleanup()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerCleanup"}),"(",(0,r.jsx)(n.code,{children:"cleanup"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cleanup"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderCleanup",children:(0,r.jsx)(n.code,{children:"ProviderCleanup"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registercontainerproviderconnection",children:"registerContainerProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerContainerProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L473",children:"packages/extension-api/src/extension-api.d.ts:473"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerinstallation",children:"registerInstallation()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerInstallation"}),"(",(0,r.jsx)(n.code,{children:"installation"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"installation"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInstallation",children:(0,r.jsx)(n.code,{children:"ProviderInstallation"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerkubernetesproviderconnection",children:"registerKubernetesProviderConnection()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerKubernetesProviderConnection"}),"(",(0,r.jsx)(n.code,{children:"connection"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L474",children:"packages/extension-api/src/extension-api.d.ts:474"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerlifecycle",children:"registerLifecycle()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerLifecycle"}),"(",(0,r.jsx)(n.code,{children:"lifecycle"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderLifecycle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L475",children:"packages/extension-api/src/extension-api.d.ts:475"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerUpdate"}),"(",(0,r.jsx)(n.code,{children:"update"}),"): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"update"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderUpdate",children:(0,r.jsx)(n.code,{children:"ProviderUpdate"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L481",children:"packages/extension-api/src/extension-api.d.ts:481"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setcontainerproviderconnectionfactory",children:"setContainerProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setContainerProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"setkubernetesproviderconnectionfactory",children:"setKubernetesProviderConnectionFactory()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"setKubernetesProviderConnectionFactory"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnectionFactory"}),", ",(0,r.jsx)(n.code,{children:"connectionAuditor"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnectionFactory"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"connectionAuditor?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Auditor",children:(0,r.jsx)(n.code,{children:"Auditor"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatedetectionchecks",children:"updateDetectionChecks()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateDetectionChecks"}),"(",(0,r.jsx)(n.code,{children:"detectionChecks"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,r.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatestatus",children:"updateStatus()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateStatus"}),"(",(0,r.jsx)(n.code,{children:"status"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L492",children:"packages/extension-api/src/extension-api.d.ts:492"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateVersion"}),"(",(0,r.jsx)(n.code,{children:"version"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L497",children:"packages/extension-api/src/extension-api.d.ts:497"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"updatewarnings",children:"updateWarnings()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"updateWarnings"}),"(",(0,r.jsx)(n.code,{children:"warnings"}),"): ",(0,r.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"warnings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,r.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L513",children:"packages/extension-api/src/extension-api.d.ts:513"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fbe0675.b1f5a1cd.js b/assets/js/1fbe0675.e090cfc3.js similarity index 84% rename from assets/js/1fbe0675.b1f5a1cd.js rename to assets/js/1fbe0675.e090cfc3.js index c2a24f6dc12..ae1456f9e6f 100644 --- a/assets/js/1fbe0675.b1f5a1cd.js +++ b/assets/js/1fbe0675.e090cfc3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{32927:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var s=n(24246),c=n(71670);const r={},a="Function: createFileSystemWatcher()",i={id:"namespaces/fs/functions/createFileSystemWatcher",title:"Function: createFileSystemWatcher()",description:"createFileSystemWatcher(path): FileSystemWatcher",source:"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",sourceDirName:"namespaces/fs/functions",slug:"/namespaces/fs/functions/createFileSystemWatcher",permalink:"/api/namespaces/fs/functions/createFileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"},next:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1415",children:"packages/extension-api/src/extension-api.d.ts:1415"})})]})}function h(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var s=n(27378);const c={},r=s.createContext(c);function a(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{32927:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var s=n(24246),c=n(71670);const r={},a="Function: createFileSystemWatcher()",i={id:"namespaces/fs/functions/createFileSystemWatcher",title:"Function: createFileSystemWatcher()",description:"createFileSystemWatcher(path): FileSystemWatcher",source:"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",sourceDirName:"namespaces/fs/functions",slug:"/namespaces/fs/functions/createFileSystemWatcher",permalink:"/api/namespaces/fs/functions/createFileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"},next:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createfilesystemwatcher",children:"Function: createFileSystemWatcher()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createFileSystemWatcher"}),"(",(0,s.jsx)(t.code,{children:"path"}),"): ",(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"path"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,s.jsx)(t.code,{children:"FileSystemWatcher"})})}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1415",children:"packages/extension-api/src/extension-api.d.ts:1415"})})]})}function d(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var s=n(27378);const c={},r=s.createContext(c);function a(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fc83a28.40a7c15b.js b/assets/js/1fc83a28.826bbf44.js similarity index 93% rename from assets/js/1fc83a28.40a7c15b.js rename to assets/js/1fc83a28.826bbf44.js index 855d26dfde4..12be48120ae 100644 --- a/assets/js/1fc83a28.40a7c15b.js +++ b/assets/js/1fc83a28.826bbf44.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{54484:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const c={},o="Interface: AuthenticationSession",r={id:"interfaces/AuthenticationSession",title:"Interface: AuthenticationSession",description:"Represents a session of a currently logged in user.",source:"@site/api/interfaces/AuthenticationSession.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"},next:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"accessToken",id:"accesstoken",level:3},{value:"Source",id:"source",level:4},{value:"account",id:"account",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"}),"\n",(0,i.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"accessToken"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The access token."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3441",children:"packages/extension-api/src/extension-api.d.ts:3441"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"account",children:"account"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"account"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3446",children:"packages/extension-api/src/extension-api.d.ts:3446"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3436",children:"packages/extension-api/src/extension-api.d.ts:3436"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"scopes"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3452",children:"packages/extension-api/src/extension-api.d.ts:3452"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},c=i.createContext(t);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{54484:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const c={},o="Interface: AuthenticationSession",r={id:"interfaces/AuthenticationSession",title:"Interface: AuthenticationSession",description:"Represents a session of a currently logged in user.",source:"@site/api/interfaces/AuthenticationSession.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"},next:{title:"AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"accessToken",id:"accesstoken",level:3},{value:"Source",id:"source",level:4},{value:"account",id:"account",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"scopes",id:"scopes",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"}),"\n",(0,i.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"accessToken"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The access token."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3441",children:"packages/extension-api/src/extension-api.d.ts:3441"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"account",children:"account"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"account"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,i.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The account associated with the session."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3446",children:"packages/extension-api/src/extension-api.d.ts:3446"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The identifier of the authentication session."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3436",children:"packages/extension-api/src/extension-api.d.ts:3436"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"scopes"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3452",children:"packages/extension-api/src/extension-api.d.ts:3452"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},c=i.createContext(t);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/22e2140b.d24ab03f.js b/assets/js/22e2140b.8a237951.js similarity index 85% rename from assets/js/22e2140b.d24ab03f.js rename to assets/js/22e2140b.8a237951.js index fa15b1204d4..da73456c51b 100644 --- a/assets/js/22e2140b.d24ab03f.js +++ b/assets/js/22e2140b.8a237951.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{9897:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=n(24246),s=n(71670);const i={},a="Type alias: ProviderResult",o={id:"type-aliases/ProviderResult",title:"Type alias: ProviderResult\\",description:"ProviderResult\\: T \\| undefined \\| Promise\\",source:"@site/api/type-aliases/ProviderResult.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderResult",permalink:"/api/type-aliases/ProviderResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"},next:{title:"ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"type-alias-providerresultt",children:"Type alias: ProviderResult"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(r.code,{children:"T"}),">: ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," | ",(0,t.jsx)(r.code,{children:"Promise"}),"<",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(r.code,{children:"T"}),", like ",(0,t.jsx)(r.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(r.code,{children:"T"}),". In addition, ",(0,t.jsx)(r.code,{children:"null"})," and ",(0,t.jsx)(r.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(r.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"let a: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n return new ImageChecks();\n }\n\nlet b: ImageCheckerProvider = {\n async check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn new ImageChecks();\n\t}\n}\n\nlet c: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn; // undefined\n\t}\n}\n"})}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L200",children:"packages/extension-api/src/extension-api.d.ts:200"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>o,a:()=>a});var t=n(27378);const s={},i=t.createContext(s);function a(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{9897:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Type alias: ProviderResult",a={id:"type-aliases/ProviderResult",title:"Type alias: ProviderResult\\",description:"ProviderResult\\: T \\| undefined \\| Promise\\",source:"@site/api/type-aliases/ProviderResult.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderResult",permalink:"/api/type-aliases/ProviderResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"},next:{title:"ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"type-alias-providerresultt",children:"Type alias: ProviderResult"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"ProviderResult"}),"<",(0,t.jsx)(r.code,{children:"T"}),">: ",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"})," | ",(0,t.jsx)(r.code,{children:"Promise"}),"<",(0,t.jsx)(r.code,{children:"T"})," | ",(0,t.jsx)(r.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsxs)(r.p,{children:["A provider result represents the values a provider, like the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),",\nmay return. For once this is the actual result type ",(0,t.jsx)(r.code,{children:"T"}),", like ",(0,t.jsx)(r.code,{children:"ImageChecks"}),", or a Promise that resolves\nto that type ",(0,t.jsx)(r.code,{children:"T"}),". In addition, ",(0,t.jsx)(r.code,{children:"null"})," and ",(0,t.jsx)(r.code,{children:"undefined"})," can be returned - either directly or from a\nPromise."]}),"\n",(0,t.jsxs)(r.p,{children:["The snippets below are all valid implementations of the ",(0,t.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,t.jsx)(r.code,{children:"ImageCheckerProvider"})}),":"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-ts",children:"let a: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n return new ImageChecks();\n }\n\nlet b: ImageCheckerProvider = {\n async check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn new ImageChecks();\n\t}\n}\n\nlet c: ImageCheckerProvider = {\n check(image: ImageInfo, token?: CancellationToken): ProviderResult {\n\t\treturn; // undefined\n\t}\n}\n"})}),"\n",(0,t.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"T"})]}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L200",children:"packages/extension-api/src/extension-api.d.ts:200"})})]})}function h(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2340b3ee.2bb300be.js b/assets/js/2340b3ee.2bb300be.js deleted file mode 100644 index 6dff9d16461..00000000000 --- a/assets/js/2340b3ee.2bb300be.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{18050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var r=s(24246),c=s(71670);const t={},o="Function: exec()",i={id:"namespaces/process/functions/exec",title:"Function: exec()",description:"exec(command, args?, options?): Promise \\",source:"@site/api/namespaces/process/functions/exec.md",sourceDirName:"namespaces/process/functions",slug:"/namespaces/process/functions/exec",permalink:"/api/namespaces/process/functions/exec",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: process",permalink:"/api/namespaces/process/"},next:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exec"}),"(",(0,r.jsx)(n.code,{children:"command"}),", ",(0,r.jsx)(n.code,{children:"args"}),"?, ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The command to execute."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"args?"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"The command arguments."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,r.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,r.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,r.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3868",children:"packages/extension-api/src/extension-api.d.ts:3868"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var r=s(27378);const c={},t=r.createContext(c);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2340b3ee.a32ba344.js b/assets/js/2340b3ee.a32ba344.js new file mode 100644 index 00000000000..d5c03cd0c9c --- /dev/null +++ b/assets/js/2340b3ee.a32ba344.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{18050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var c=s(24246),r=s(71670);const t={},o="Function: exec()",i={id:"namespaces/process/functions/exec",title:"Function: exec()",description:"exec(command, args?, options?): Promise \\",source:"@site/api/namespaces/process/functions/exec.md",sourceDirName:"namespaces/process/functions",slug:"/namespaces/process/functions/exec",permalink:"/api/namespaces/process/functions/exec",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: process",permalink:"/api/namespaces/process/"},next:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-exec",children:"Function: exec()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"exec"}),"(",(0,c.jsx)(n.code,{children:"command"}),", ",(0,c.jsx)(n.code,{children:"args"}),"?, ",(0,c.jsx)(n.code,{children:"options"}),"?): ",(0,c.jsx)(n.code,{children:"Promise"})," <",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Executes the provided command and returns an object containing the exit code,\nstdout, and stderr content."}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"command"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.p,{children:"The command to execute."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"args?"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,c.jsx)(n.p,{children:"The command arguments."}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"options?"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/RunOptions",children:(0,c.jsx)(n.code,{children:"RunOptions"})})]}),"\n",(0,c.jsx)(n.p,{children:"Options, such as environment variables."}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"Promise"})," <",(0,c.jsx)(n.a,{href:"/api/interfaces/RunResult",children:(0,c.jsx)(n.code,{children:"RunResult"})}),">"]}),"\n",(0,c.jsx)(n.p,{children:"A promise that resolves to a RunResult object."}),"\n",(0,c.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.a,{href:"/api/interfaces/RunError",children:"RunError"})," if provided command can not be executed."]}),"\n",(0,c.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3868",children:"packages/extension-api/src/extension-api.d.ts:3868"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var c=s(27378);const r={},t=c.createContext(r);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/23a8e291.9000e27d.js b/assets/js/23a8e291.70fe0cbb.js similarity index 96% rename from assets/js/23a8e291.9000e27d.js rename to assets/js/23a8e291.70fe0cbb.js index ace4d82a6b0..35bc9a29293 100644 --- a/assets/js/23a8e291.9000e27d.js +++ b/assets/js/23a8e291.70fe0cbb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{23101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: ConfigurationChangeEvent",c={id:"interfaces/ConfigurationChangeEvent",title:"Interface: ConfigurationChangeEvent",description:"An event describing the change in Configuration",source:"@site/api/interfaces/ConfigurationChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Configuration",permalink:"/api/interfaces/Configuration"},next:{title:"ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"affectsConfiguration()",id:"affectsconfiguration",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,i.jsx)(n.code,{children:"section"}),", ",(0,i.jsx)(n.code,{children:"scope"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Checks if the given section has changed.\nIf scope is provided, checks if the section has changed for resources under the given scope."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration name, supports ",(0,i.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scope?"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,i.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,i.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L753",children:"packages/extension-api/src/extension-api.d.ts:753"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{23101:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: ConfigurationChangeEvent",c={id:"interfaces/ConfigurationChangeEvent",title:"Interface: ConfigurationChangeEvent",description:"An event describing the change in Configuration",source:"@site/api/interfaces/ConfigurationChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Configuration",permalink:"/api/interfaces/Configuration"},next:{title:"ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"affectsConfiguration()",id:"affectsconfiguration",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-configurationchangeevent",children:"Interface: ConfigurationChangeEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the change in Configuration"}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"affectsconfiguration",children:"affectsConfiguration()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"affectsConfiguration"}),"(",(0,i.jsx)(n.code,{children:"section"}),", ",(0,i.jsx)(n.code,{children:"scope"}),"?): ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Checks if the given section has changed.\nIf scope is provided, checks if the section has changed for resources under the given scope."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["Configuration name, supports ",(0,i.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scope?"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,i.jsx)(n.code,{children:"ConfigurationScope"})})]}),"\n",(0,i.jsx)(n.p,{children:"A scope in which to check."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the given section has changed."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L753",children:"packages/extension-api/src/extension-api.d.ts:753"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/24dadce3.5668b0ad.js b/assets/js/24dadce3.711efd0e.js similarity index 53% rename from assets/js/24dadce3.5668b0ad.js rename to assets/js/24dadce3.711efd0e.js index 52fced7b13c..f48ce583669 100644 --- a/assets/js/24dadce3.5668b0ad.js +++ b/assets/js/24dadce3.711efd0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{64784:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var r=n(24246),c=n(71670);const o={},i="Interface: LifecycleContext",s={id:"interfaces/LifecycleContext",title:"Interface: LifecycleContext",description:"Properties",source:"@site/api/interfaces/LifecycleContext.md",sourceDirName:"interfaces",slug:"/interfaces/LifecycleContext",permalink:"/api/interfaces/LifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"},next:{title:"Link",permalink:"/api/interfaces/Link"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"log",id:"log",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"log",children:"log"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"log"}),": ",(0,r.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(t.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L263",children:"packages/extension-api/src/extension-api.d.ts:263"})})]})}function p(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var r=n(27378);const c={},o=r.createContext(c);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{64784:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var c=n(24246),r=n(71670);const o={},i="Interface: LifecycleContext",s={id:"interfaces/LifecycleContext",title:"Interface: LifecycleContext",description:"Properties",source:"@site/api/interfaces/LifecycleContext.md",sourceDirName:"interfaces",slug:"/interfaces/LifecycleContext",permalink:"/api/interfaces/LifecycleContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory"},next:{title:"Link",permalink:"/api/interfaces/Link"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"log",id:"log",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.h1,{id:"interface-lifecyclecontext",children:"Interface: LifecycleContext"}),"\n",(0,c.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(t.h3,{id:"log",children:"log"}),"\n",(0,c.jsxs)(t.blockquote,{children:["\n",(0,c.jsxs)(t.p,{children:[(0,c.jsx)(t.strong,{children:"log"}),": ",(0,c.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,c.jsx)(t.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,c.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(t.p,{children:(0,c.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L263",children:"packages/extension-api/src/extension-api.d.ts:263"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>s,a:()=>i});var c=n(27378);const r={},o=c.createContext(r);function i(e){const t=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),c.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/254d0ff5.90b00f9c.js b/assets/js/254d0ff5.5d9e482a.js similarity index 95% rename from assets/js/254d0ff5.90b00f9c.js rename to assets/js/254d0ff5.5d9e482a.js index 1f55c5e7103..11b9c5727ab 100644 --- a/assets/js/254d0ff5.90b00f9c.js +++ b/assets/js/254d0ff5.5d9e482a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{66520:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=r(24246),i=r(71670);const t={},s="Interface: ProviderImages",c={id:"interfaces/ProviderImages",title:"Interface: ProviderImages",description:"Properties",source:"@site/api/interfaces/ProviderImages.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderImages",permalink:"/api/interfaces/ProviderImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"logo?",id:"logo",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"icon"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L459",children:"packages/extension-api/src/extension-api.d.ts:459"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"logo",children:"logo?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"logo"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const i={},t=o.createContext(i);function s(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{66520:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=r(24246),i=r(71670);const t={},s="Interface: ProviderImages",c={id:"interfaces/ProviderImages",title:"Interface: ProviderImages",description:"Properties",source:"@site/api/interfaces/ProviderImages.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderImages",permalink:"/api/interfaces/ProviderImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderEvent",permalink:"/api/interfaces/ProviderEvent"},next:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"logo?",id:"logo",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providerimages",children:"Interface: ProviderImages"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"icon"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L459",children:"packages/extension-api/src/extension-api.d.ts:459"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"logo",children:"logo?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"logo"}),": ",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var o=r(27378);const i={},t=o.createContext(i);function s(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/271ff0d1.9407a25b.js b/assets/js/271ff0d1.5dd08dea.js similarity index 96% rename from assets/js/271ff0d1.9407a25b.js rename to assets/js/271ff0d1.5dd08dea.js index 8c0576058e4..252915fe060 100644 --- a/assets/js/271ff0d1.9407a25b.js +++ b/assets/js/271ff0d1.5dd08dea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{27192:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise \\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/OpenDialogOptions",children:(0,o.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1751",children:"packages/extension-api/src/extension-api.d.ts:1751"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{27192:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showOpenDialog()",r={id:"namespaces/window/functions/showOpenDialog",title:"Function: showOpenDialog()",description:"showOpenDialog(options?): Promise \\",source:"@site/api/namespaces/window/functions/showOpenDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"},next:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showopendialog",children:"Function: showOpenDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showOpenDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file open dialog to the user which allows to select a file\nfor opening-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/OpenDialogOptions",children:(0,o.jsx)(n.code,{children:"OpenDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[] | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resources or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1751",children:"packages/extension-api/src/extension-api.d.ts:1751"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/280646e4.a55fd209.js b/assets/js/280646e4.b135c66c.js similarity index 92% rename from assets/js/280646e4.a55fd209.js rename to assets/js/280646e4.b135c66c.js index ea1d5328937..d2b19c3d97b 100644 --- a/assets/js/280646e4.a55fd209.js +++ b/assets/js/280646e4.b135c66c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{56663:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var n=t(24246),c=t(71670);const r={},i="Interface: HealthCheckResults",a={id:"interfaces/HealthCheckResults",title:"Interface: HealthCheckResults",description:"HealthCheckResults describes the results/logs from a healthcheck",source:"@site/api/interfaces/HealthCheckResults.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"},next:{title:"HealthConfig",permalink:"/api/interfaces/HealthConfig"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Source",id:"source",level:4},{value:"Log",id:"log",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"}),"\n",(0,n.jsx)(s.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"FailingStreak"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,n.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"log",children:"Log"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Log"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/HealthCheckLog",children:(0,n.jsx)(s.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,n.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"status",children:"Status"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Status"}),": ",(0,n.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,n.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})})]})}function d(e={}){const{wrapper:s}={...(0,c.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>a,a:()=>i});var n=t(27378);const c={},r=n.createContext(c);function i(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{56663:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>o});var n=t(24246),c=t(71670);const r={},i="Interface: HealthCheckResults",a={id:"interfaces/HealthCheckResults",title:"Interface: HealthCheckResults",description:"HealthCheckResults describes the results/logs from a healthcheck",source:"@site/api/interfaces/HealthCheckResults.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"},next:{title:"HealthConfig",permalink:"/api/interfaces/HealthConfig"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"FailingStreak",id:"failingstreak",level:3},{value:"Source",id:"source",level:4},{value:"Log",id:"log",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"interface-healthcheckresults",children:"Interface: HealthCheckResults"}),"\n",(0,n.jsx)(s.p,{children:"HealthCheckResults describes the results/logs from a healthcheck"}),"\n",(0,n.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(s.h3,{id:"failingstreak",children:"FailingStreak"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"FailingStreak"}),": ",(0,n.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"FailingStreak is the number of consecutive failed healthchecks"}),"\n",(0,n.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"log",children:"Log"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Log"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/HealthCheckLog",children:(0,n.jsx)(s.code,{children:"HealthCheckLog"})}),"[]"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Log describes healthcheck attempts and results"}),"\n",(0,n.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:"status",children:"Status"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"Status"}),": ",(0,n.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Status is starting, healthy or unhealthy"}),"\n",(0,n.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})})]})}function d(e={}){const{wrapper:s}={...(0,c.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>a,a:()=>i});var n=t(27378);const c={},r=n.createContext(c);function i(e){const s=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),n.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2bb2c1cd.9502b14e.js b/assets/js/2bb2c1cd.65f059e4.js similarity index 97% rename from assets/js/2bb2c1cd.9502b14e.js rename to assets/js/2bb2c1cd.65f059e4.js index 01dc572574b..3f9e3ed9730 100644 --- a/assets/js/2bb2c1cd.9502b14e.js +++ b/assets/js/2bb2c1cd.65f059e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{21239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EndpointsConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,i.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{21239:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: NetworkingConfig",c={id:"interfaces/NetworkingConfig",title:"Interface: NetworkingConfig",description:"Properties",source:"@site/api/interfaces/NetworkingConfig.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"},next:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"EndpointsConfig?",id:"endpointsconfig",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkingconfig",children:"Interface: NetworkingConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpointsconfig",children:"EndpointsConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EndpointsConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointSettings",children:(0,i.jsx)(n.code,{children:"EndpointSettings"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2cb13d6d.f1903984.js b/assets/js/2cb13d6d.20130a1f.js similarity index 83% rename from assets/js/2cb13d6d.f1903984.js rename to assets/js/2cb13d6d.20130a1f.js index cf5d1bf4efc..98dbdbbacb0 100644 --- a/assets/js/2cb13d6d.f1903984.js +++ b/assets/js/2cb13d6d.20130a1f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{34952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: BlkioStatEntry",c={id:"interfaces/BlkioStatEntry",title:"Interface: BlkioStatEntry",description:"Properties",source:"@site/api/interfaces/BlkioStatEntry.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"},next:{title:"BlkioStats",permalink:"/api/interfaces/BlkioStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Source",id:"source",level:4},{value:"minor",id:"minor",level:3},{value:"Source",id:"source-1",level:4},{value:"op",id:"op",level:3},{value:"Source",id:"source-2",level:4},{value:"value",id:"value",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"major"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2803",children:"packages/extension-api/src/extension-api.d.ts:2803"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"minor"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2804",children:"packages/extension-api/src/extension-api.d.ts:2804"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"op"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2806",children:"packages/extension-api/src/extension-api.d.ts:2806"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{34952:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=t(24246),r=t(71670);const i={},o="Interface: BlkioStatEntry",c={id:"interfaces/BlkioStatEntry",title:"Interface: BlkioStatEntry",description:"Properties",source:"@site/api/interfaces/BlkioStatEntry.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"},next:{title:"BlkioStats",permalink:"/api/interfaces/BlkioStats"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"major",id:"major",level:3},{value:"Source",id:"source",level:4},{value:"minor",id:"minor",level:3},{value:"Source",id:"source-1",level:4},{value:"op",id:"op",level:3},{value:"Source",id:"source-2",level:4},{value:"value",id:"value",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-blkiostatentry",children:"Interface: BlkioStatEntry"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"major",children:"major"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"major"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2803",children:"packages/extension-api/src/extension-api.d.ts:2803"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"minor",children:"minor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"minor"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2804",children:"packages/extension-api/src/extension-api.d.ts:2804"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"op",children:"op"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"op"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"value",children:"value"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2806",children:"packages/extension-api/src/extension-api.d.ts:2806"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3109d9d2.fa128bad.js b/assets/js/3109d9d2.ed797d7d.js similarity index 94% rename from assets/js/3109d9d2.fa128bad.js rename to assets/js/3109d9d2.ed797d7d.js index 5e9752e7559..db0e8eccb0f 100644 --- a/assets/js/3109d9d2.fa128bad.js +++ b/assets/js/3109d9d2.ed797d7d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{20057:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-2",level:2},{value:"Type parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Source",id:"source-2",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-3",level:2},{value:"Type parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Source",id:"source-3",level:3}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1770",children:"packages/extension-api/src/extension-api.d.ts:1770"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1798",children:"packages/extension-api/src/extension-api.d.ts:1798"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1812",children:"packages/extension-api/src/extension-api.d.ts:1812"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{20057:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const o={},r="Function: showQuickPick()",t={id:"namespaces/window/functions/showQuickPick",title:"Function: showQuickPick()",description:"showQuickPick(items, options, token)",source:"@site/api/namespaces/window/functions/showQuickPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"},next:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"}},d={},l=[{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-2",level:2},{value:"Type parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Source",id:"source-2",level:3},{value:"showQuickPick(items, options, token)",id:"showquickpickitems-options-token-3",level:2},{value:"Type parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Source",id:"source-3",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showquickpick",children:"Function: showQuickPick()"}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1770",children:"packages/extension-api/src/extension-api.d.ts:1770"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-1",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"string"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of strings, or a promise that resolves to an array of strings."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selection or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1784",children:"packages/extension-api/src/extension-api.d.ts:1784"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-2",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),", ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list allowing multiple selections."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected items or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1798",children:"packages/extension-api/src/extension-api.d.ts:1798"})}),"\n",(0,i.jsx)(n.h2,{id:"showquickpickitems-options-token-3",children:"showQuickPick(items, options, token)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showQuickPick"}),"<",(0,i.jsx)(n.code,{children:"T"}),">(",(0,i.jsx)(n.code,{children:"items"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?, ",(0,i.jsx)(n.code,{children:"token"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows a selection list."}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,i.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"items"}),": readonly ",(0,i.jsx)(n.code,{children:"T"}),"[] | ",(0,i.jsx)(n.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(n.p,{children:"An array of items, or a promise that resolves to an array of items."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/QuickPickOptions",children:(0,i.jsx)(n.code,{children:"QuickPickOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Configures the behavior of the selection list."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"token?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,i.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"T"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1812",children:"packages/extension-api/src/extension-api.d.ts:1812"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3132913e.41c11196.js b/assets/js/3132913e.3644c321.js similarity index 81% rename from assets/js/3132913e.41c11196.js rename to assets/js/3132913e.3644c321.js index 3719604745e..a4be7df752b 100644 --- a/assets/js/3132913e.41c11196.js +++ b/assets/js/3132913e.3644c321.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{98755:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=s(24246),t=s(71670);const r={},o="Interface: SaveDialogOptions",a={id:"interfaces/SaveDialogOptions",title:"Interface: SaveDialogOptions",description:"Options to configure the behaviour of a file save dialog.",source:"@site/api/interfaces/SaveDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunResult",permalink:"/api/interfaces/RunResult"},next:{title:"SecretStorage",permalink:"/api/interfaces/SecretStorage"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Source",id:"source-2",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file save dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1590",children:"packages/extension-api/src/extension-api.d.ts:1590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"saveLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1595",children:"packages/extension-api/src/extension-api.d.ts:1595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1608",children:"packages/extension-api/src/extension-api.d.ts:1608"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{98755:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const r={},o="Interface: SaveDialogOptions",c={id:"interfaces/SaveDialogOptions",title:"Interface: SaveDialogOptions",description:"Options to configure the behaviour of a file save dialog.",source:"@site/api/interfaces/SaveDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/SaveDialogOptions",permalink:"/api/interfaces/SaveDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunResult",permalink:"/api/interfaces/RunResult"},next:{title:"SecretStorage",permalink:"/api/interfaces/SecretStorage"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"saveLabel?",id:"savelabel",level:3},{value:"Source",id:"source-2",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-savedialogoptions",children:"Interface: SaveDialogOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behaviour of a file save dialog."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"defaultUri"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1590",children:"packages/extension-api/src/extension-api.d.ts:1590"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"filters"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1600",children:"packages/extension-api/src/extension-api.d.ts:1600"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"savelabel",children:"saveLabel?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"saveLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string for the save button."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1595",children:"packages/extension-api/src/extension-api.d.ts:1595"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dialog title."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1608",children:"packages/extension-api/src/extension-api.d.ts:1608"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/35300761.a5f864fb.js b/assets/js/35300761.fcfef048.js similarity index 82% rename from assets/js/35300761.a5f864fb.js rename to assets/js/35300761.fcfef048.js index f7ee18b1a7a..22156b9db68 100644 --- a/assets/js/35300761.a5f864fb.js +++ b/assets/js/35300761.fcfef048.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{98639:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: MenuItem",d={id:"interfaces/MenuItem",title:"Interface: MenuItem",description:"Properties",source:"@site/api/interfaces/MenuItem.md",sourceDirName:"interfaces",slug:"/interfaces/MenuItem",permalink:"/api/interfaces/MenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"},next:{title:"MountSettings",permalink:"/api/interfaces/MountSettings"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Source",id:"source",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Source",id:"source-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"label?",id:"label",level:3},{value:"Source",id:"source-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Source",id:"source-5",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Source",id:"source-7",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"checked",children:"checked?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"checked"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Should only be specified for ",(0,i.jsx)(n.code,{children:"checkbox"})," or ",(0,i.jsx)(n.code,{children:"radio"})," type menu items."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L79",children:"packages/extension-api/src/extension-api.d.ts:79"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L71",children:"packages/extension-api/src/extension-api.d.ts:71"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L67",children:"packages/extension-api/src/extension-api.d.ts:67"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L65",children:"packages/extension-api/src/extension-api.d.ts:65"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"submenu"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,i.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L81",children:"packages/extension-api/src/extension-api.d.ts:81"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:'"normal"'})," | ",(0,i.jsx)(n.code,{children:'"separator"'})," | ",(0,i.jsx)(n.code,{children:'"submenu"'})," | ",(0,i.jsx)(n.code,{children:'"checkbox"'})," | ",(0,i.jsx)(n.code,{children:'"radio"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L64",children:"packages/extension-api/src/extension-api.d.ts:64"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L75",children:"packages/extension-api/src/extension-api.d.ts:75"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{98639:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: MenuItem",t={id:"interfaces/MenuItem",title:"Interface: MenuItem",description:"Properties",source:"@site/api/interfaces/MenuItem.md",sourceDirName:"interfaces",slug:"/interfaces/MenuItem",permalink:"/api/interfaces/MenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"},next:{title:"MountSettings",permalink:"/api/interfaces/MountSettings"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"checked?",id:"checked",level:3},{value:"Source",id:"source",level:4},{value:"enabled?",id:"enabled",level:3},{value:"Source",id:"source-1",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"label?",id:"label",level:3},{value:"Source",id:"source-4",level:4},{value:"submenu?",id:"submenu",level:3},{value:"Source",id:"source-5",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-6",level:4},{value:"visible?",id:"visible",level:3},{value:"Source",id:"source-7",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"checked",children:"checked?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"checked"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Should only be specified for ",(0,i.jsx)(n.code,{children:"checkbox"})," or ",(0,i.jsx)(n.code,{children:"radio"})," type menu items."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L79",children:"packages/extension-api/src/extension-api.d.ts:79"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L71",children:"packages/extension-api/src/extension-api.d.ts:71"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L67",children:"packages/extension-api/src/extension-api.d.ts:67"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L65",children:"packages/extension-api/src/extension-api.d.ts:65"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"submenu"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,i.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L81",children:"packages/extension-api/src/extension-api.d.ts:81"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:'"normal"'})," | ",(0,i.jsx)(n.code,{children:'"separator"'})," | ",(0,i.jsx)(n.code,{children:'"submenu"'})," | ",(0,i.jsx)(n.code,{children:'"checkbox"'})," | ",(0,i.jsx)(n.code,{children:'"radio"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L64",children:"packages/extension-api/src/extension-api.d.ts:64"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L75",children:"packages/extension-api/src/extension-api.d.ts:75"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3866940b.17c2b646.js b/assets/js/3866940b.01d0b3bc.js similarity index 80% rename from assets/js/3866940b.17c2b646.js rename to assets/js/3866940b.01d0b3bc.js index 7a797d4f453..15520cc1cf1 100644 --- a/assets/js/3866940b.17c2b646.js +++ b/assets/js/3866940b.01d0b3bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{44011:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=r(24246),i=r(71670);const o={},s="Interface: ProviderInformation",a={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L226",children:"packages/extension-api/src/extension-api.d.ts:226"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L225",children:"packages/extension-api/src/extension-api.d.ts:225"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{44011:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);const o={},s="Interface: ProviderInformation",c={id:"interfaces/ProviderInformation",title:"Interface: ProviderInformation",description:"Properties",source:"@site/api/interfaces/ProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInformation",permalink:"/api/interfaces/ProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"},next:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"details?",id:"details",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerinformation",children:"Interface: ProviderInformation"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"details",children:"details?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"details"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L226",children:"packages/extension-api/src/extension-api.d.ts:226"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L225",children:"packages/extension-api/src/extension-api.d.ts:225"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/39ae3791.98c608dd.js b/assets/js/39ae3791.ea84cf90.js similarity index 84% rename from assets/js/39ae3791.98c608dd.js rename to assets/js/39ae3791.ea84cf90.js index 2c9f7ea504a..fd8fd5c8e99 100644 --- a/assets/js/39ae3791.98c608dd.js +++ b/assets/js/39ae3791.ea84cf90.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{74605:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: ProviderLifecycle",d={id:"interfaces/ProviderLifecycle",title:"Interface: ProviderLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"},next:{title:"ProviderOptions",permalink:"/api/interfaces/ProviderOptions"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(",(0,r.jsx)(n.code,{children:"initContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"initContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L216",children:"packages/extension-api/src/extension-api.d.ts:216"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L217",children:"packages/extension-api/src/extension-api.d.ts:217"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L219",children:"packages/extension-api/src/extension-api.d.ts:219"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L218",children:"packages/extension-api/src/extension-api.d.ts:218"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{74605:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const t={},c="Interface: ProviderLifecycle",o={id:"interfaces/ProviderLifecycle",title:"Interface: ProviderLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation"},next:{title:"ProviderOptions",permalink:"/api/interfaces/ProviderOptions"}},d={},l=[{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()",id:"stop",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-providerlifecycle",children:"Interface: ProviderLifecycle"}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(",(0,r.jsx)(n.code,{children:"initContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"initContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L216",children:"packages/extension-api/src/extension-api.d.ts:216"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"start",children:"start()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"start"}),"(",(0,r.jsx)(n.code,{children:"startContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"startContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L217",children:"packages/extension-api/src/extension-api.d.ts:217"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,r.jsx)(n.code,{children:"ProviderStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L219",children:"packages/extension-api/src/extension-api.d.ts:219"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stop",children:"stop()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stop"}),"(",(0,r.jsx)(n.code,{children:"stopContext"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"stopContext"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,r.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L218",children:"packages/extension-api/src/extension-api.d.ts:218"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3a38a610.c7e34470.js b/assets/js/3a38a610.058c912b.js similarity index 83% rename from assets/js/3a38a610.c7e34470.js rename to assets/js/3a38a610.058c912b.js index e8655bf9d88..ff734583f84 100644 --- a/assets/js/3a38a610.c7e34470.js +++ b/assets/js/3a38a610.058c912b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{38889:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),c=s(71670);const r={},d="Interface: ImageInfo",o={id:"interfaces/ImageInfo",title:"Interface: ImageInfo",description:"Properties",source:"@site/api/interfaces/ImageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInfo",permalink:"/api/interfaces/ImageInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"Digest",id:"digest",level:3},{value:"Source",id:"source-2",level:4},{value:"History?",id:"history",level:3},{value:"Source",id:"source-3",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Source",id:"source-6",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Source",id:"source-7",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-8",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Source",id:"source-9",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-10",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-11",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-12",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-13",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Source",id:"source-14",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1907",children:"packages/extension-api/src/extension-api.d.ts:1907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1902",children:"packages/extension-api/src/extension-api.d.ts:1902"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"digest",children:"Digest"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Digest"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"history",children:"History?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"History"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1908",children:"packages/extension-api/src/extension-api.d.ts:1908"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1898",children:"packages/extension-api/src/extension-api.d.ts:1898"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1906",children:"packages/extension-api/src/extension-api.d.ts:1906"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ParentId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1899",children:"packages/extension-api/src/extension-api.d.ts:1899"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1901",children:"packages/extension-api/src/extension-api.d.ts:1901"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1900",children:"packages/extension-api/src/extension-api.d.ts:1900"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SharedSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1905",children:"packages/extension-api/src/extension-api.d.ts:1905"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1903",children:"packages/extension-api/src/extension-api.d.ts:1903"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1904",children:"packages/extension-api/src/extension-api.d.ts:1904"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1896",children:"packages/extension-api/src/extension-api.d.ts:1896"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1897",children:"packages/extension-api/src/extension-api.d.ts:1897"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isManifest"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1912",children:"packages/extension-api/src/extension-api.d.ts:1912"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{38889:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ImageInfo",d={id:"interfaces/ImageInfo",title:"Interface: ImageInfo",description:"Properties",source:"@site/api/interfaces/ImageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInfo",permalink:"/api/interfaces/ImageInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"},next:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Containers",id:"containers",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"Digest",id:"digest",level:3},{value:"Source",id:"source-2",level:4},{value:"History?",id:"history",level:3},{value:"Source",id:"source-3",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-4",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-5",level:4},{value:"ParentId",id:"parentid",level:3},{value:"Source",id:"source-6",level:4},{value:"RepoDigests?",id:"repodigests",level:3},{value:"Source",id:"source-7",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-8",level:4},{value:"SharedSize",id:"sharedsize",level:3},{value:"Source",id:"source-9",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-10",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-11",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-12",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-13",level:4},{value:"isManifest?",id:"ismanifest",level:3},{value:"Source",id:"source-14",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinfo",children:"Interface: ImageInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1907",children:"packages/extension-api/src/extension-api.d.ts:1907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1902",children:"packages/extension-api/src/extension-api.d.ts:1902"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"digest",children:"Digest"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Digest"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"history",children:"History?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"History"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1908",children:"packages/extension-api/src/extension-api.d.ts:1908"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1898",children:"packages/extension-api/src/extension-api.d.ts:1898"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1906",children:"packages/extension-api/src/extension-api.d.ts:1906"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parentid",children:"ParentId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ParentId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1899",children:"packages/extension-api/src/extension-api.d.ts:1899"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1901",children:"packages/extension-api/src/extension-api.d.ts:1901"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1900",children:"packages/extension-api/src/extension-api.d.ts:1900"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sharedsize",children:"SharedSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SharedSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1905",children:"packages/extension-api/src/extension-api.d.ts:1905"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1903",children:"packages/extension-api/src/extension-api.d.ts:1903"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1904",children:"packages/extension-api/src/extension-api.d.ts:1904"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1896",children:"packages/extension-api/src/extension-api.d.ts:1896"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1897",children:"packages/extension-api/src/extension-api.d.ts:1897"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ismanifest",children:"isManifest?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isManifest"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1912",children:"packages/extension-api/src/extension-api.d.ts:1912"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3ba80b69.7742d5cb.js b/assets/js/3ba80b69.2a8ce54c.js similarity index 91% rename from assets/js/3ba80b69.7742d5cb.js rename to assets/js/3ba80b69.2a8ce54c.js index 62f4c0ae0c2..840deee7476 100644 --- a/assets/js/3ba80b69.7742d5cb.js +++ b/assets/js/3ba80b69.2a8ce54c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{1266:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),c=t(71670);const r={},i="Interface: HealthCheckLog",o={id:"interfaces/HealthCheckLog",title:"Interface: HealthCheckLog",description:"HealthCheckLog describes the results of a single healthcheck",source:"@site/api/interfaces/HealthCheckLog.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"},next:{title:"HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Source",id:"source",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Source",id:"source-1",level:4},{value:"Output",id:"output",level:3},{value:"Source",id:"source-2",level:4},{value:"Start",id:"start",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"End"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"End time as a string"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exitcode",children:"ExitCode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExitCode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Exitcode is 0 or 1"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"output",children:"Output"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Output"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Start"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start time as string"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{1266:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),c=t(71670);const r={},i="Interface: HealthCheckLog",o={id:"interfaces/HealthCheckLog",title:"Interface: HealthCheckLog",description:"HealthCheckLog describes the results of a single healthcheck",source:"@site/api/interfaces/HealthCheckLog.md",sourceDirName:"interfaces",slug:"/interfaces/HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"},next:{title:"HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"End",id:"end",level:3},{value:"Source",id:"source",level:4},{value:"ExitCode",id:"exitcode",level:3},{value:"Source",id:"source-1",level:4},{value:"Output",id:"output",level:3},{value:"Source",id:"source-2",level:4},{value:"Start",id:"start",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-healthchecklog",children:"Interface: HealthCheckLog"}),"\n",(0,s.jsx)(n.p,{children:"HealthCheckLog describes the results of a single healthcheck"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"end",children:"End"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"End"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"End time as a string"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"exitcode",children:"ExitCode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ExitCode"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Exitcode is 0 or 1"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"output",children:"Output"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Output"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Output is the stdout/stderr from the healthcheck command"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"Start"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Start"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Start time as string"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3e2b82eb.b373b852.js b/assets/js/3e2b82eb.a0f13645.js similarity index 95% rename from assets/js/3e2b82eb.b373b852.js rename to assets/js/3e2b82eb.a0f13645.js index 4f76690252a..6d2403b013a 100644 --- a/assets/js/3e2b82eb.b373b852.js +++ b/assets/js/3e2b82eb.a0f13645.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{18825:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolume()",c={id:"namespaces/navigation/functions/navigateToVolume",title:"Function: navigateToVolume()",description:"navigateToVolume(name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolume.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources"},next:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,o.jsx)(n.code,{children:"name"}),", ",(0,o.jsx)(n.code,{children:"engineId"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"name"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"engineId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{18825:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolume()",c={id:"namespaces/navigation/functions/navigateToVolume",title:"Function: navigateToVolume()",description:"navigateToVolume(name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolume.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToResources",permalink:"/api/namespaces/navigation/functions/navigateToResources"},next:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolume",children:"Function: navigateToVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolume"}),"(",(0,o.jsx)(n.code,{children:"name"}),", ",(0,o.jsx)(n.code,{children:"engineId"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"name"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"engineId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4200",children:"packages/extension-api/src/extension-api.d.ts:4200"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f66023b.8c172c62.js b/assets/js/3f66023b.cb3acf65.js similarity index 85% rename from assets/js/3f66023b.8c172c62.js rename to assets/js/3f66023b.cb3acf65.js index 6dcec49b051..2ac3f2714a4 100644 --- a/assets/js/3f66023b.8c172c62.js +++ b/assets/js/3f66023b.cb3acf65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91442:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerInfo",d={id:"interfaces/ContainerInfo",title:"Interface: ContainerInfo",description:"Properties",source:"@site/api/interfaces/ContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInfo",permalink:"/api/interfaces/ContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"},next:{title:"ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Image",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Source",id:"source-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-7",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-8",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"Source",id:"source-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Source",id:"source-10",level:4},{value:"State",id:"state",level:3},{value:"Source",id:"source-11",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"Command"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2031",children:"packages/extension-api/src/extension-api.d.ts:2031"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2032",children:"packages/extension-api/src/extension-api.d.ts:2032"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2037",children:"packages/extension-api/src/extension-api.d.ts:2037"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2027",children:"packages/extension-api/src/extension-api.d.ts:2027"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2029",children:"packages/extension-api/src/extension-api.d.ts:2029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ImageID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2030",children:"packages/extension-api/src/extension-api.d.ts:2030"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2034",children:"packages/extension-api/src/extension-api.d.ts:2034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2043",children:"packages/extension-api/src/extension-api.d.ts:2043"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Names"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2028",children:"packages/extension-api/src/extension-api.d.ts:2028"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"networkType"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,i.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,i.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2035",children:"packages/extension-api/src/extension-api.d.ts:2035"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2036",children:"packages/extension-api/src/extension-api.d.ts:2036"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2024",children:"packages/extension-api/src/extension-api.d.ts:2024"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2025",children:"packages/extension-api/src/extension-api.d.ts:2025"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91442:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: ContainerInfo",t={id:"interfaces/ContainerInfo",title:"Interface: ContainerInfo",description:"Properties",source:"@site/api/interfaces/ContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInfo",permalink:"/api/interfaces/ContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"},next:{title:"ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Command",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-1",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"NetworkMode",id:"networkmode",level:4},{value:"Source",id:"source-2",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"Image",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"ImageID",id:"imageid",level:3},{value:"Source",id:"source-5",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-6",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-7",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-8",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"Source",id:"source-9",level:4},{value:"Ports",id:"ports",level:3},{value:"Source",id:"source-10",level:4},{value:"State",id:"state",level:3},{value:"Source",id:"source-11",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-12",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-13",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-14",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-15",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"Command"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2031",children:"packages/extension-api/src/extension-api.d.ts:2031"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2032",children:"packages/extension-api/src/extension-api.d.ts:2032"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2037",children:"packages/extension-api/src/extension-api.d.ts:2037"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2027",children:"packages/extension-api/src/extension-api.d.ts:2027"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2029",children:"packages/extension-api/src/extension-api.d.ts:2029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ImageID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2030",children:"packages/extension-api/src/extension-api.d.ts:2030"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2034",children:"packages/extension-api/src/extension-api.d.ts:2034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2043",children:"packages/extension-api/src/extension-api.d.ts:2043"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Names"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2028",children:"packages/extension-api/src/extension-api.d.ts:2028"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"networkType"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,i.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2040",children:"packages/extension-api/src/extension-api.d.ts:2040"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,i.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2033",children:"packages/extension-api/src/extension-api.d.ts:2033"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2035",children:"packages/extension-api/src/extension-api.d.ts:2035"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2036",children:"packages/extension-api/src/extension-api.d.ts:2036"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2024",children:"packages/extension-api/src/extension-api.d.ts:2024"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2025",children:"packages/extension-api/src/extension-api.d.ts:2025"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2026",children:"packages/extension-api/src/extension-api.d.ts:2026"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3f797343.e95db70a.js b/assets/js/3f797343.988030e3.js similarity index 76% rename from assets/js/3f797343.e95db70a.js rename to assets/js/3f797343.988030e3.js index 153055938af..14f16f1132c 100644 --- a/assets/js/3f797343.e95db70a.js +++ b/assets/js/3f797343.988030e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{97814:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const i={},s="Interface: ProviderCleanupExecuteOptions",c={id:"interfaces/ProviderCleanupExecuteOptions",title:"Interface: ProviderCleanupExecuteOptions",description:"Properties",source:"@site/api/interfaces/ProviderCleanupExecuteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"},next:{title:"ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"logger",id:"logger",level:3},{value:"Source",id:"source",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L444",children:"packages/extension-api/src/extension-api.d.ts:444"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"token"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L445",children:"packages/extension-api/src/extension-api.d.ts:445"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{97814:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=r(24246),o=r(71670);const i={},c="Interface: ProviderCleanupExecuteOptions",s={id:"interfaces/ProviderCleanupExecuteOptions",title:"Interface: ProviderCleanupExecuteOptions",description:"Properties",source:"@site/api/interfaces/ProviderCleanupExecuteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"},next:{title:"ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"logger",id:"logger",level:3},{value:"Source",id:"source",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupexecuteoptions",children:"Interface: ProviderCleanupExecuteOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"logger",children:"logger"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L444",children:"packages/extension-api/src/extension-api.d.ts:444"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"token"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L445",children:"packages/extension-api/src/extension-api.d.ts:445"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var t=r(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/40d377be.5a8fc5de.js b/assets/js/40d377be.37712df2.js similarity index 79% rename from assets/js/40d377be.5a8fc5de.js rename to assets/js/40d377be.37712df2.js index 680a89c1c4f..dc0e93822be 100644 --- a/assets/js/40d377be.5a8fc5de.js +++ b/assets/js/40d377be.37712df2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{61634:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),r=s(71670);const t={},o="Interface: ManifestCreateOptions",c={id:"interfaces/ManifestCreateOptions",title:"Interface: ManifestCreateOptions",description:"Properties",source:"@site/api/interfaces/ManifestCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Logger",permalink:"/api/interfaces/Logger"},next:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Source",id:"source",level:4},{value:"amend?",id:"amend",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"all",children:"all?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"all"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"amend",children:"amend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"amend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L310",children:"packages/extension-api/src/extension-api.d.ts:310"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L309",children:"packages/extension-api/src/extension-api.d.ts:309"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{61634:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),r=s(71670);const t={},c="Interface: ManifestCreateOptions",o={id:"interfaces/ManifestCreateOptions",title:"Interface: ManifestCreateOptions",description:"Properties",source:"@site/api/interfaces/ManifestCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Logger",permalink:"/api/interfaces/Logger"},next:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"all?",id:"all",level:3},{value:"Source",id:"source",level:4},{value:"amend?",id:"amend",level:3},{value:"Source",id:"source-1",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-2",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestcreateoptions",children:"Interface: ManifestCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"all",children:"all?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"all"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L311",children:"packages/extension-api/src/extension-api.d.ts:311"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"amend",children:"amend?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"amend"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L310",children:"packages/extension-api/src/extension-api.d.ts:310"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L309",children:"packages/extension-api/src/extension-api.d.ts:309"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/416d4fcf.3e0c5e2e.js b/assets/js/416d4fcf.8158d7d1.js similarity index 96% rename from assets/js/416d4fcf.3e0c5e2e.js rename to assets/js/416d4fcf.8158d7d1.js index fe45c8b9a9a..c39a469e845 100644 --- a/assets/js/416d4fcf.3e0c5e2e.js +++ b/assets/js/416d4fcf.8158d7d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{66030:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const a={},o="Interface: ContainerCreateResult",s={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"}),"\n",(0,i.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2788",children:"packages/extension-api/src/extension-api.d.ts:2788"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(27378);const r={},a=i.createContext(r);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{66030:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const a={},o="Interface: ContainerCreateResult",s={id:"interfaces/ContainerCreateResult",title:"Interface: ContainerCreateResult",description:"Information about the container created by calling the containerEngine.createContainer method",source:"@site/api/interfaces/ContainerCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"},next:{title:"ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containercreateresult",children:"Interface: ContainerCreateResult"}),"\n",(0,i.jsxs)(n.p,{children:["Information about the container created by calling the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})," method"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["a string uniquely identifying the created container, which can be used to execute other methods on the container (",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/deleteContainer",children:"containerEngine.deleteContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/startContainer",children:"containerEngine.startContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/stopContainer",children:"containerEngine.stopContainer"}),", ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/logsContainer",children:"containerEngine.logsContainer"}),")"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2788",children:"packages/extension-api/src/extension-api.d.ts:2788"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(27378);const r={},a=i.createContext(r);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/41b2e801.51c4ca2f.js b/assets/js/41b2e801.a9f2ea71.js similarity index 98% rename from assets/js/41b2e801.51c4ca2f.js rename to assets/js/41b2e801.a9f2ea71.js index 31e110a444e..3b5563747f3 100644 --- a/assets/js/41b2e801.51c4ca2f.js +++ b/assets/js/41b2e801.a9f2ea71.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{71450:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>t,toc:()=>d});var s=n(24246),i=n(71670);const a={},c="Function: registerImageCheckerProvider()",t={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,s.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,s.jsx)(r.code,{children:"metadata"}),"?): ",(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,s.jsx)(r.p,{children:"As an image checker, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,s.jsxs)(r.p,{children:["an object implementing the ",(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"metadata?"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,s.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,s.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,s.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4174",children:"packages/extension-api/src/extension-api.d.ts:4174"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>t,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const r=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{71450:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>t,toc:()=>d});var s=n(24246),i=n(71670);const a={},c="Function: registerImageCheckerProvider()",t={id:"namespaces/imageChecker/functions/registerImageCheckerProvider",title:"Function: registerImageCheckerProvider()",description:"registerImageCheckerProvider(imageCheckerProvider, metadata?): Disposable",source:"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",sourceDirName:"namespaces/imageChecker/functions",slug:"/namespaces/imageChecker/functions/registerImageCheckerProvider",permalink:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: imageChecker",permalink:"/api/namespaces/imageChecker/"},next:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.h1,{id:"function-registerimagecheckerprovider",children:"Function: registerImageCheckerProvider()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"registerImageCheckerProvider"}),"(",(0,s.jsx)(r.code,{children:"imageCheckerProvider"}),", ",(0,s.jsx)(r.code,{children:"metadata"}),"?): ",(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(r.p,{children:"Register the extension as an Image Checker."}),"\n",(0,s.jsx)(r.p,{children:"As an image checker, a provider needs to implement a specific interface, so the core\napplication can call the provider with specific tasks when necessary."}),"\n",(0,s.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"imageCheckerProvider"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProvider",children:(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})})]}),"\n",(0,s.jsxs)(r.p,{children:["an object implementing the ",(0,s.jsx)(r.code,{children:"ImageCheckerProvider"})," interface"]}),"\n",(0,s.jsxs)(r.p,{children:["\u2022 ",(0,s.jsx)(r.strong,{children:"metadata?"}),": ",(0,s.jsx)(r.a,{href:"/api/interfaces/ImageCheckerProviderMetadata",children:(0,s.jsx)(r.code,{children:"ImageCheckerProviderMetadata"})})]}),"\n",(0,s.jsx)(r.p,{children:"optional metadata attached to this provider"}),"\n",(0,s.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(r.p,{children:"A disposable that unregisters this provider when being disposed"}),"\n",(0,s.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(r.p,{children:(0,s.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4174",children:"packages/extension-api/src/extension-api.d.ts:4174"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>t,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const r=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/423842d7.7e4ffadb.js b/assets/js/423842d7.5fe5a772.js similarity index 96% rename from assets/js/423842d7.7e4ffadb.js rename to assets/js/423842d7.5fe5a772.js index 9be2f03b634..9fdf19b10fb 100644 --- a/assets/js/423842d7.7e4ffadb.js +++ b/assets/js/423842d7.5fe5a772.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{6695:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Type alias: KubernetesGeneratorArgument",c={id:"type-aliases/KubernetesGeneratorArgument",title:"Type alias: KubernetesGeneratorArgument",description:"KubernetesGeneratorArgument: object",source:"@site/api/type-aliases/KubernetesGeneratorArgument.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"},next:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"compose?",id:"compose",level:3},{value:"containers?",id:"containers",level:3},{value:"engineId",id:"engineid",level:3},{value:"pods?",id:"pods",level:3},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"compose"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"containers",children:"containers?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"containers"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"pods",children:"pods?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1878",children:"packages/extension-api/src/extension-api.d.ts:1878"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{6695:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Type alias: KubernetesGeneratorArgument",c={id:"type-aliases/KubernetesGeneratorArgument",title:"Type alias: KubernetesGeneratorArgument",description:"KubernetesGeneratorArgument: object",source:"@site/api/type-aliases/KubernetesGeneratorArgument.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"},next:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"}},a={},l=[{value:"Type declaration",id:"type-declaration",level:2},{value:"compose?",id:"compose",level:3},{value:"containers?",id:"containers",level:3},{value:"engineId",id:"engineid",level:3},{value:"pods?",id:"pods",level:3},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"type-alias-kubernetesgeneratorargument",children:"Type alias: KubernetesGeneratorArgument"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"KubernetesGeneratorArgument"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"type-declaration",children:"Type declaration"}),"\n",(0,r.jsx)(n.h3,{id:"compose",children:"compose?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"compose"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"containers",children:"containers?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"containers"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"pods",children:"pods?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"pods"}),": ",(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1878",children:"packages/extension-api/src/extension-api.d.ts:1878"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/42b67a8e.5e089350.js b/assets/js/42b67a8e.de26eeaf.js similarity index 85% rename from assets/js/42b67a8e.5e089350.js rename to assets/js/42b67a8e.de26eeaf.js index 36d700d9277..42487b6634c 100644 --- a/assets/js/42b67a8e.5e089350.js +++ b/assets/js/42b67a8e.de26eeaf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{76906:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=n(24246),r=n(71670);const o={},i="Interface: HostRestartPolicy",c={id:"interfaces/HostRestartPolicy",title:"Interface: HostRestartPolicy",description:"Properties",source:"@site/api/interfaces/HostRestartPolicy.md",sourceDirName:"interfaces",slug:"/interfaces/HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HostConfig",permalink:"/api/interfaces/HostConfig"},next:{title:"IPAM",permalink:"/api/interfaces/IPAM"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"MaximumRetryCount?",id:"maximumretrycount",level:3},{value:"Source",id:"source",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"optional"})," ",(0,s.jsx)(t.strong,{children:"MaximumRetryCount"}),": ",(0,s.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2124",children:"packages/extension-api/src/extension-api.d.ts:2124"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Name"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2123",children:"packages/extension-api/src/extension-api.d.ts:2123"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var s=n(27378);const r={},o=s.createContext(r);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{76906:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var s=n(24246),r=n(71670);const o={},i="Interface: HostRestartPolicy",c={id:"interfaces/HostRestartPolicy",title:"Interface: HostRestartPolicy",description:"Properties",source:"@site/api/interfaces/HostRestartPolicy.md",sourceDirName:"interfaces",slug:"/interfaces/HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HostConfig",permalink:"/api/interfaces/HostConfig"},next:{title:"IPAM",permalink:"/api/interfaces/IPAM"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"MaximumRetryCount?",id:"maximumretrycount",level:3},{value:"Source",id:"source",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-hostrestartpolicy",children:"Interface: HostRestartPolicy"}),"\n",(0,s.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(t.h3,{id:"maximumretrycount",children:"MaximumRetryCount?"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"optional"})," ",(0,s.jsx)(t.strong,{children:"MaximumRetryCount"}),": ",(0,s.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2124",children:"packages/extension-api/src/extension-api.d.ts:2124"})}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"Name"}),": ",(0,s.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2123",children:"packages/extension-api/src/extension-api.d.ts:2123"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var s=n(27378);const r={},o=s.createContext(r);function i(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43be69c9.7aff94ec.js b/assets/js/43be69c9.b3336065.js similarity index 93% rename from assets/js/43be69c9.7aff94ec.js rename to assets/js/43be69c9.b3336065.js index d615994ee2b..b14783ca976 100644 --- a/assets/js/43be69c9.7aff94ec.js +++ b/assets/js/43be69c9.b3336065.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{40409:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=n(24246),c=n(71670);const t={},r="Interface: QuickPickItem",o={id:"interfaces/QuickPickItem",title:"Interface: QuickPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/QuickPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickItem",permalink:"/api/interfaces/QuickPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickInputButton",permalink:"/api/interfaces/QuickInputButton"},next:{title:"QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Source",id:"source",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Source",id:"source-1",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Source",id:"source-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Source",id:"source-4",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1066",children:"packages/extension-api/src/extension-api.d.ts:1066"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"buttons",children:"buttons?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"buttons"}),": readonly ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickInputButton",children:(0,s.jsx)(i.code,{children:"QuickInputButton"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional buttons that will be rendered on this particular item. These buttons will trigger\nan QuickPickItemButtonEvent when clicked. Buttons are only rendered when using a quickpick\ncreated by the window.createQuickPick createQuickPick() API. Buttons are not rendered when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1076",children:"packages/extension-api/src/extension-api.d.ts:1076"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"description",children:"description?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"description"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in the same line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1038",children:"packages/extension-api/src/extension-api.d.ts:1038"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"detail",children:"detail?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"detail"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in a separate line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1046",children:"packages/extension-api/src/extension-api.d.ts:1046"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"kind",children:"kind?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"kind"}),": ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind",children:(0,s.jsx)(i.code,{children:"QuickPickItemKind"})})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,\nthe default is ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#default",children:"QuickPickItemKind.Default"}),"."]}),"\n",(0,s.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1030",children:"packages/extension-api/src/extension-api.d.ts:1030"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"label",children:"label"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"label"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via\nthe ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1024",children:"packages/extension-api/src/extension-api.d.ts:1024"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"picked",children:"picked?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"picked"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional flag indicating if this item is picked initially. This is only honored when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API. To do the same thing with\nthe window.createQuickPick createQuickPick() API, simply set the QuickPick.selectedItems\nto the items you want picked initially.\n(",(0,s.jsx)(i.em,{children:"Note:"})," This is only honored when the picker allows multiple selections.)"]}),"\n",(0,s.jsx)(i.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickOptions#canpickmany",children:"QuickPickOptions.canPickMany"})}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1059",children:"packages/extension-api/src/extension-api.d.ts:1059"})})]})}function h(e={}){const{wrapper:i}={...(0,c.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>o,a:()=>r});var s=n(27378);const c={},t=s.createContext(c);function r(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{40409:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=n(24246),c=n(71670);const t={},r="Interface: QuickPickItem",o={id:"interfaces/QuickPickItem",title:"Interface: QuickPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/QuickPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickItem",permalink:"/api/interfaces/QuickPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickInputButton",permalink:"/api/interfaces/QuickInputButton"},next:{title:"QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"alwaysShow?",id:"alwaysshow",level:3},{value:"Source",id:"source",level:4},{value:"buttons?",id:"buttons",level:3},{value:"Source",id:"source-1",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-2",level:4},{value:"detail?",id:"detail",level:3},{value:"Source",id:"source-3",level:4},{value:"kind?",id:"kind",level:3},{value:"Source",id:"source-4",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-5",level:4},{value:"picked?",id:"picked",level:3},{value:"See",id:"see",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,s.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"Always show this item."}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1066",children:"packages/extension-api/src/extension-api.d.ts:1066"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"buttons",children:"buttons?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"buttons"}),": readonly ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickInputButton",children:(0,s.jsx)(i.code,{children:"QuickInputButton"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional buttons that will be rendered on this particular item. These buttons will trigger\nan QuickPickItemButtonEvent when clicked. Buttons are only rendered when using a quickpick\ncreated by the window.createQuickPick createQuickPick() API. Buttons are not rendered when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1076",children:"packages/extension-api/src/extension-api.d.ts:1076"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"description",children:"description?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"description"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in the same line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1038",children:"packages/extension-api/src/extension-api.d.ts:1038"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"detail",children:"detail?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"detail"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered less prominent in a separate line. Supports rendering of\nThemeIcon theme icons via the ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1046",children:"packages/extension-api/src/extension-api.d.ts:1046"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"kind",children:"kind?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"kind"}),": ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind",children:(0,s.jsx)(i.code,{children:"QuickPickItemKind"})})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,\nthe default is ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#default",children:"QuickPickItemKind.Default"}),"."]}),"\n",(0,s.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1030",children:"packages/extension-api/src/extension-api.d.ts:1030"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"label",children:"label"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.strong,{children:"label"}),": ",(0,s.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via\nthe ",(0,s.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,s.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1024",children:"packages/extension-api/src/extension-api.d.ts:1024"})}),"\n",(0,s.jsx)(i.hr,{}),"\n",(0,s.jsx)(i.h3,{id:"picked",children:"picked?"}),"\n",(0,s.jsxs)(i.blockquote,{children:["\n",(0,s.jsxs)(i.p,{children:[(0,s.jsx)(i.code,{children:"optional"})," ",(0,s.jsx)(i.strong,{children:"picked"}),": ",(0,s.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Optional flag indicating if this item is picked initially. This is only honored when using\nthe ",(0,s.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API. To do the same thing with\nthe window.createQuickPick createQuickPick() API, simply set the QuickPick.selectedItems\nto the items you want picked initially.\n(",(0,s.jsx)(i.em,{children:"Note:"})," This is only honored when the picker allows multiple selections.)"]}),"\n",(0,s.jsx)(i.h4,{id:"see",children:"See"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickOptions#canpickmany",children:"QuickPickOptions.canPickMany"})}),"\n",(0,s.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,s.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,s.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,s.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(i.p,{children:(0,s.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1059",children:"packages/extension-api/src/extension-api.d.ts:1059"})})]})}function h(e={}){const{wrapper:i}={...(0,c.a)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>o,a:()=>r});var s=n(27378);const c={},t=s.createContext(c);function r(e){const i=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44287967.ce548982.js b/assets/js/44287967.f60e6b36.js similarity index 98% rename from assets/js/44287967.ce548982.js rename to assets/js/44287967.f60e6b36.js index 08d593481de..fe93f6090fc 100644 --- a/assets/js/44287967.ce548982.js +++ b/assets/js/44287967.f60e6b36.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{17321:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(24246),i=s(71670);const a={},r="Function: statsContainer()",o={id:"namespaces/containerEngine/functions/statsContainer",title:"Function: statsContainer()",description:"statsContainer(engineId, id, callback): Promise \\",source:"@site/api/namespaces/containerEngine/functions/statsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-statscontainer",children:"Function: statsContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"statsContainer"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed stats of a running container."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when container stats info are emitted."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A Promise resolving a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," that unregister the callback when called."]}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.p,{children:"Here is a usage example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {\n console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);\n});\n\n// When no longer needed\ndisposable.dispose();\n"})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3261",children:"packages/extension-api/src/extension-api.d.ts:3261"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{17321:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var t=s(24246),i=s(71670);const a={},r="Function: statsContainer()",o={id:"namespaces/containerEngine/functions/statsContainer",title:"Function: statsContainer()",description:"statsContainer(engineId, id, callback): Promise \\",source:"@site/api/namespaces/containerEngine/functions/statsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"},next:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Example",id:"example",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-statscontainer",children:"Function: statsContainer()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"statsContainer"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"id"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Get the streamed stats of a running container."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when container stats info are emitted."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A Promise resolving a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," that unregister the callback when called."]}),"\n",(0,t.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.p,{children:"Here is a usage example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"const disposable = await statsContainer('engineId', 'containerId', (stats: ContainerStatsInfo): void => {\n console.log('CPU Usage', stats.cpu_stats.cpu_usage.total_usage);\n});\n\n// When no longer needed\ndisposable.dispose();\n"})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3261",children:"packages/extension-api/src/extension-api.d.ts:3261"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/456c0e28.e247b041.js b/assets/js/456c0e28.9cd2ca6b.js similarity index 90% rename from assets/js/456c0e28.e247b041.js rename to assets/js/456c0e28.9cd2ca6b.js index baf615576bf..23265cb072b 100644 --- a/assets/js/456c0e28.e247b041.js +++ b/assets/js/456c0e28.9cd2ca6b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{53870:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Interface: PodContainerInfo",c={id:"interfaces/PodContainerInfo",title:"Interface: PodContainerInfo",description:"Properties",source:"@site/api/interfaces/PodContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PidsStats",permalink:"/api/interfaces/PidsStats"},next:{title:"PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcontainerinfo",children:"Interface: PodContainerInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2078",children:"packages/extension-api/src/extension-api.d.ts:2078"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Names"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2079",children:"packages/extension-api/src/extension-api.d.ts:2079"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Status"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2080",children:"packages/extension-api/src/extension-api.d.ts:2080"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{53870:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Interface: PodContainerInfo",c={id:"interfaces/PodContainerInfo",title:"Interface: PodContainerInfo",description:"Properties",source:"@site/api/interfaces/PodContainerInfo.md",sourceDirName:"interfaces",slug:"/interfaces/PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PidsStats",permalink:"/api/interfaces/PidsStats"},next:{title:"PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"Names",id:"names",level:3},{value:"Source",id:"source-1",level:4},{value:"Status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcontainerinfo",children:"Interface: PodContainerInfo"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2078",children:"packages/extension-api/src/extension-api.d.ts:2078"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Names"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2079",children:"packages/extension-api/src/extension-api.d.ts:2079"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Status"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2080",children:"packages/extension-api/src/extension-api.d.ts:2080"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46669adc.e5f5ddde.js b/assets/js/46669adc.35ac227c.js similarity index 95% rename from assets/js/46669adc.e5f5ddde.js rename to assets/js/46669adc.35ac227c.js index c3265cebefb..f69ab77a5df 100644 --- a/assets/js/46669adc.e5f5ddde.js +++ b/assets/js/46669adc.35ac227c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{81902:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const c={},i="Interface: AuditRecord",o={id:"interfaces/AuditRecord",title:"Interface: AuditRecord",description:"Properties",source:"@site/api/interfaces/AuditRecord.md",sourceDirName:"interfaces",slug:"/interfaces/AuditRecord",permalink:"/api/interfaces/AuditRecord",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Uri",permalink:"/api/classes/Uri"},next:{title:"AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"record"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"error"'})," | ",(0,t.jsx)(n.code,{children:'"info"'})," | ",(0,t.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var t=r(27378);const s={},c=t.createContext(s);function i(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{81902:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const c={},i="Interface: AuditRecord",o={id:"interfaces/AuditRecord",title:"Interface: AuditRecord",description:"Properties",source:"@site/api/interfaces/AuditRecord.md",sourceDirName:"interfaces",slug:"/interfaces/AuditRecord",permalink:"/api/interfaces/AuditRecord",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Uri",permalink:"/api/classes/Uri"},next:{title:"AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"record",id:"record",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-auditrecord",children:"Interface: AuditRecord"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"record",children:"record"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"record"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L371",children:"packages/extension-api/src/extension-api.d.ts:371"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:'"error"'})," | ",(0,t.jsx)(n.code,{children:'"info"'})," | ",(0,t.jsx)(n.code,{children:'"warning"'})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>i});var t=r(27378);const s={},c=t.createContext(s);function i(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/46b3c144.986cc880.js b/assets/js/46b3c144.854079d3.js similarity index 88% rename from assets/js/46b3c144.986cc880.js rename to assets/js/46b3c144.854079d3.js index fddf76b8f9c..c14f6b55556 100644 --- a/assets/js/46b3c144.986cc880.js +++ b/assets/js/46b3c144.854079d3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{5e3:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const r={},i="Interface: PodCreatePortOptions",c={id:"interfaces/PodCreatePortOptions",title:"Interface: PodCreatePortOptions",description:"Properties",source:"@site/api/interfaces/PodCreatePortOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"},next:{title:"PodInfo",permalink:"/api/interfaces/PodInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Source",id:"source",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Source",id:"source-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Source",id:"source-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Source",id:"source-3",level:4},{value:"range",id:"range",level:3},{value:"Source",id:"source-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L294",children:"packages/extension-api/src/extension-api.d.ts:294"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L296",children:"packages/extension-api/src/extension-api.d.ts:296"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>i});var t=o(27378);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{5e3:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=o(24246),s=o(71670);const r={},i="Interface: PodCreatePortOptions",c={id:"interfaces/PodCreatePortOptions",title:"Interface: PodCreatePortOptions",description:"Properties",source:"@site/api/interfaces/PodCreatePortOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions"},next:{title:"PodInfo",permalink:"/api/interfaces/PodInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"container_port",id:"container_port",level:3},{value:"Source",id:"source",level:4},{value:"host_ip",id:"host_ip",level:3},{value:"Source",id:"source-1",level:4},{value:"host_port",id:"host_port",level:3},{value:"Source",id:"source-2",level:4},{value:"protocol",id:"protocol",level:3},{value:"Source",id:"source-3",level:4},{value:"range",id:"range",level:3},{value:"Source",id:"source-4",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-podcreateportoptions",children:"Interface: PodCreatePortOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"container_port",children:"container_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"container_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_ip",children:"host_ip"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_ip"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"host_port",children:"host_port"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"host_port"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L294",children:"packages/extension-api/src/extension-api.d.ts:294"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"protocol",children:"protocol"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"protocol"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"range",children:"range"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"range"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L296",children:"packages/extension-api/src/extension-api.d.ts:296"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>i});var t=o(27378);const s={},r=t.createContext(s);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/494e8e75.08b0f314.js b/assets/js/494e8e75.cf1e1680.js similarity index 97% rename from assets/js/494e8e75.08b0f314.js rename to assets/js/494e8e75.cf1e1680.js index b23cae45df2..e076334fb40 100644 --- a/assets/js/494e8e75.08b0f314.js +++ b/assets/js/494e8e75.cf1e1680.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{32849:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{32849:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterContainerConnectionEvent",c={id:"interfaces/UnregisterContainerConnectionEvent",title:"Interface: UnregisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"},next:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregistercontainerconnectionevent",children:"Interface: UnregisterContainerConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/49bee2be.492890ac.js b/assets/js/49bee2be.bbd0c7bc.js similarity index 95% rename from assets/js/49bee2be.492890ac.js rename to assets/js/49bee2be.bbd0c7bc.js index 70108b5b37b..0a682fecef1 100644 --- a/assets/js/49bee2be.492890ac.js +++ b/assets/js/49bee2be.bbd0c7bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{35471:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>u});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContainers()",r={id:"namespaces/navigation/functions/navigateToContainers",title:"Function: navigateToContainers()",description:"navigateToContainers(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainers.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"},next:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"}},c={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4182",children:"packages/extension-api/src/extension-api.d.ts:4182"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{35471:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>u});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContainers()",r={id:"namespaces/navigation/functions/navigateToContainers",title:"Function: navigateToContainers()",description:"navigateToContainers(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainers.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"},next:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"}},c={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainers",children:"Function: navigateToContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4182",children:"packages/extension-api/src/extension-api.d.ts:4182"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/49d9416a.6d97fa5b.js b/assets/js/49d9416a.c53a1450.js similarity index 85% rename from assets/js/49d9416a.6d97fa5b.js rename to assets/js/49d9416a.c53a1450.js index 143a24128eb..e0b20ce047a 100644 --- a/assets/js/49d9416a.6d97fa5b.js +++ b/assets/js/49d9416a.c53a1450.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{84149:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const r={},a="Function: startContainer()",o={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3226",children:"packages/extension-api/src/extension-api.d.ts:3226"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>o,a:()=>a});var i=t(27378);const s={},r=i.createContext(s);function a(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function o(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{84149:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Function: startContainer()",a={id:"namespaces/containerEngine/functions/startContainer",title:"Function: startContainer()",description:"startContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"},next:{title:"startPod",permalink:"/api/namespaces/containerEngine/functions/startPod"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-startcontainer",children:"Function: startContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"startContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Start an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3226",children:"packages/extension-api/src/extension-api.d.ts:3226"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(n){const e=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),i.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c217c25.3826c1e7.js b/assets/js/4c217c25.747e67eb.js similarity index 79% rename from assets/js/4c217c25.3826c1e7.js rename to assets/js/4c217c25.747e67eb.js index f151d53499f..bf0899a5641 100644 --- a/assets/js/4c217c25.3826c1e7.js +++ b/assets/js/4c217c25.747e67eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{28482:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",a={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"},next:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"}},c={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3197",children:"packages/extension-api/src/extension-api.d.ts:3197"})})]})}function p(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{28482:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var i=t(24246),s=t(71670);const o={},r="Function: listContainers()",c={id:"namespaces/containerEngine/functions/listContainers",title:"Function: listContainers()",description:"listContainers(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listContainers.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"},next:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listcontainers",children:"Function: listContainers()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listContainers"}),"(): ",(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Returns the list of containers across all container engines, in any state (running or not)."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerInfo",children:(0,i.jsx)(e.code,{children:"ContainerInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(e.p,{children:["A promise resolving to an array of containers information. This method returns a subset of the available information for containers. To get the complete description of a specific container, you can use the ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," method."]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3197",children:"packages/extension-api/src/extension-api.d.ts:3197"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c5becac.d0817f64.js b/assets/js/4c5becac.ce937a14.js similarity index 88% rename from assets/js/4c5becac.d0817f64.js rename to assets/js/4c5becac.ce937a14.js index 24723611f02..da58adb58ad 100644 --- a/assets/js/4c5becac.d0817f64.js +++ b/assets/js/4c5becac.ce937a14.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{52519:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var t=n(24246),r=n(71670);const i={},c="Class: EventEmitter",d={id:"classes/EventEmitter",title:"Class: EventEmitter\\",description:"A class to create and manage an Event for clients to subscribe to.",source:"@site/api/classes/EventEmitter.md",sourceDirName:"classes",slug:"/classes/EventEmitter",permalink:"/api/classes/EventEmitter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Disposable",permalink:"/api/classes/Disposable"},next:{title:"TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue"}},o={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new EventEmitter()",id:"new-eventemitter",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"event",id:"event",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-eventemittert",children:"Class: EventEmitter"}),"\n",(0,t.jsxs)(s.p,{children:["A class to create and manage an ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:"Event"})," for clients to subscribe to.\nThe emitter can only send one kind of event."]}),"\n",(0,t.jsx)(s.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(): ",(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"event",children:"event"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"event"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(s.code,{children:"Event"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L139",children:"packages/extension-api/src/extension-api.d.ts:139"})}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"dispose"}),"(): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L148",children:"packages/extension-api/src/extension-api.d.ts:148"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"fire"}),"(",(0,t.jsx)(s.code,{children:"data"}),"): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"data"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L144",children:"packages/extension-api/src/extension-api.d.ts:144"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>c});var t=n(27378);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{52519:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var t=n(24246),r=n(71670);const i={},c="Class: EventEmitter",o={id:"classes/EventEmitter",title:"Class: EventEmitter\\",description:"A class to create and manage an Event for clients to subscribe to.",source:"@site/api/classes/EventEmitter.md",sourceDirName:"classes",slug:"/classes/EventEmitter",permalink:"/api/classes/EventEmitter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Disposable",permalink:"/api/classes/Disposable"},next:{title:"TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue"}},d={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new EventEmitter()",id:"new-eventemitter",level:3},{value:"Returns",id:"returns",level:4},{value:"Properties",id:"properties",level:2},{value:"event",id:"event",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"fire()",id:"fire",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-eventemittert",children:"Class: EventEmitter"}),"\n",(0,t.jsxs)(s.p,{children:["A class to create and manage an ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:"Event"})," for clients to subscribe to.\nThe emitter can only send one kind of event."]}),"\n",(0,t.jsx)(s.p,{children:"Use this class to send events inside extension or provide API to the other\nextensions."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-eventemitter",children:"new EventEmitter()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new EventEmitter"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(): ",(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/EventEmitter",children:(0,t.jsx)(s.code,{children:"EventEmitter"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"event",children:"event"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"event"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,t.jsx)(s.code,{children:"Event"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"For the public to allow to subscribe to events from this Emitter"}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L139",children:"packages/extension-api/src/extension-api.d.ts:139"})}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"dispose"}),"(): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"Dispose by removing registered listeners"}),"\n",(0,t.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L148",children:"packages/extension-api/src/extension-api.d.ts:148"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"fire",children:"fire()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"fire"}),"(",(0,t.jsx)(s.code,{children:"data"}),"): ",(0,t.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"To fire an event to the subscribers"}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"data"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.code,{children:"void"})}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L144",children:"packages/extension-api/src/extension-api.d.ts:144"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var t=n(27378);const r={},i=t.createContext(r);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4f425ff4.02cc3b48.js b/assets/js/4f425ff4.5ed6ed12.js similarity index 98% rename from assets/js/4f425ff4.02cc3b48.js rename to assets/js/4f425ff4.5ed6ed12.js index bf087a37c69..2a69f7f8b67 100644 --- a/assets/js/4f425ff4.02cc3b48.js +++ b/assets/js/4f425ff4.5ed6ed12.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{53078:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L584",children:"packages/extension-api/src/extension-api.d.ts:584"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{53078:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateContainerConnection()",c={id:"namespaces/provider/functions/onDidUpdateContainerConnection",title:"Function: onDidUpdateContainerConnection()",description:"onDidUpdateContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"},next:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatecontainerconnection",children:"Function: onDidUpdateContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L584",children:"packages/extension-api/src/extension-api.d.ts:584"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4f9e8711.88484072.js b/assets/js/4f9e8711.692f7279.js similarity index 94% rename from assets/js/4f9e8711.88484072.js rename to assets/js/4f9e8711.692f7279.js index 43577f4de07..784b4386cb8 100644 --- a/assets/js/4f9e8711.88484072.js +++ b/assets/js/4f9e8711.692f7279.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{469:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var t=i(24246),r=i(71670);const o={},c="Interface: ProviderConnectionFactory",s={id:"interfaces/ProviderConnectionFactory",title:"Interface: ProviderConnectionFactory",description:"Extended by",source:"@site/api/interfaces/ProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"},next:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,t.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"initialize"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var t=i(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{469:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var t=i(24246),r=i(71670);const o={},c="Interface: ProviderConnectionFactory",s={id:"interfaces/ProviderConnectionFactory",title:"Interface: ProviderConnectionFactory",description:"Extended by",source:"@site/api/interfaces/ProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"},next:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"}},d={},a=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerconnectionfactory",children:"Interface: ProviderConnectionFactory"}),"\n",(0,t.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnectionFactory"})})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionFactory",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnectionFactory"})})}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"initialize"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var t=i(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5046ea8f.0c7d2dc9.js b/assets/js/5046ea8f.0ab713b7.js similarity index 86% rename from assets/js/5046ea8f.0c7d2dc9.js rename to assets/js/5046ea8f.0ab713b7.js index 1c59af55c99..861d33dd0a0 100644 --- a/assets/js/5046ea8f.0c7d2dc9.js +++ b/assets/js/5046ea8f.0ab713b7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{13531:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>g,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(24246),n=t(71670);const i={},c="Function: suggestRegistry()",o={id:"namespaces/registry/functions/suggestRegistry",title:"Function: suggestRegistry()",description:"suggestRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/suggestRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"},next:{title:"unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"suggestRegistry"}),"(",(0,r.jsx)(s.code,{children:"registry"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"registry"}),": ",(0,r.jsx)(s.a,{href:"/api/interfaces/RegistrySuggestedProvider",children:(0,r.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L666",children:"packages/extension-api/src/extension-api.d.ts:666"})})]})}function g(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>o,a:()=>c});var r=t(27378);const n={},i=r.createContext(n);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{13531:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=t(24246),n=t(71670);const i={},c="Function: suggestRegistry()",o={id:"namespaces/registry/functions/suggestRegistry",title:"Function: suggestRegistry()",description:"suggestRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/suggestRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"},next:{title:"unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function g(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-suggestregistry",children:"Function: suggestRegistry()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"suggestRegistry"}),"(",(0,r.jsx)(s.code,{children:"registry"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"registry"}),": ",(0,r.jsx)(s.a,{href:"/api/interfaces/RegistrySuggestedProvider",children:(0,r.jsx)(s.code,{children:"RegistrySuggestedProvider"})})]}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L666",children:"packages/extension-api/src/extension-api.d.ts:666"})})]})}function d(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(g,{...e})}):g(e)}},71670:(e,s,t)=>{t.d(s,{Z:()=>o,a:()=>c});var r=t(27378);const n={},i=r.createContext(n);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/54d805e4.a31ef43d.js b/assets/js/54d805e4.b28214cc.js similarity index 86% rename from assets/js/54d805e4.a31ef43d.js rename to assets/js/54d805e4.b28214cc.js index d102b0e7ff2..f15824c0ddb 100644 --- a/assets/js/54d805e4.a31ef43d.js +++ b/assets/js/54d805e4.b28214cc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{72045:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const r={},t="Interface: VolumeListInfo",c={id:"interfaces/VolumeListInfo",title:"Interface: VolumeListInfo",description:"Properties",source:"@site/api/interfaces/VolumeListInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeInfo",permalink:"/api/interfaces/VolumeInfo"},next:{title:"Webview",permalink:"/api/interfaces/Webview"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Source",id:"source",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,i.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3152",children:"packages/extension-api/src/extension-api.d.ts:3152"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Warnings"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{72045:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const r={},t="Interface: VolumeListInfo",c={id:"interfaces/VolumeListInfo",title:"Interface: VolumeListInfo",description:"Properties",source:"@site/api/interfaces/VolumeListInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeInfo",permalink:"/api/interfaces/VolumeInfo"},next:{title:"Webview",permalink:"/api/interfaces/Webview"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"Volumes",id:"volumes",level:3},{value:"Source",id:"source",level:4},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumelistinfo",children:"Interface: VolumeListInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/VolumeInfo",children:(0,i.jsx)(n.code,{children:"VolumeInfo"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3152",children:"packages/extension-api/src/extension-api.d.ts:3152"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Warnings"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3153",children:"packages/extension-api/src/extension-api.d.ts:3153"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3154",children:"packages/extension-api/src/extension-api.d.ts:3154"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3155",children:"packages/extension-api/src/extension-api.d.ts:3155"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var i=s(27378);const o={},r=i.createContext(o);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57a8015d.94a47880.js b/assets/js/57a8015d.ce32507b.js similarity index 98% rename from assets/js/57a8015d.94a47880.js rename to assets/js/57a8015d.ce32507b.js index e73b3a81cd2..1a741b8f670 100644 --- a/assets/js/57a8015d.94a47880.js +++ b/assets/js/57a8015d.ce32507b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{47845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"Namespace: process",permalink:"/api/namespaces/process/"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4216",children:"packages/extension-api/src/extension-api.d.ts:4216"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{47845:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},o="Function: navigateToWebview()",c={id:"namespaces/navigation/functions/navigateToWebview",title:"Function: navigateToWebview()",description:"navigateToWebview(webviewId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToWebview.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes"},next:{title:"Namespace: process",permalink:"/api/namespaces/process/"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"See",id:"see",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-navigatetowebview",children:"Function: navigateToWebview()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"navigateToWebview"}),"(",(0,s.jsx)(n.code,{children:"webviewId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Navigate to a specific Webview"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"webviewId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The id of the Webview to navigate to"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/listWebviews",children:"listWebviews"})," to get a list of Webviews and their ids"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/api/namespaces/window/functions/createWebviewPanel",children:"createWebviewPanel"})," for creating a Webview"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4216",children:"packages/extension-api/src/extension-api.d.ts:4216"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var s=i(27378);const t={},a=s.createContext(t);function o(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57dba496.2430ba1d.js b/assets/js/57dba496.2c5fd896.js similarity index 84% rename from assets/js/57dba496.2430ba1d.js rename to assets/js/57dba496.2c5fd896.js index 09f0aa330a2..6dd079eb878 100644 --- a/assets/js/57dba496.2430ba1d.js +++ b/assets/js/57dba496.2c5fd896.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{85801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const t={},c="Interface: PullEvent",o={id:"interfaces/PullEvent",title:"Interface: PullEvent",description:"Properties",source:"@site/api/interfaces/PullEvent.md",sourceDirName:"interfaces",slug:"/interfaces/PullEvent",permalink:"/api/interfaces/PullEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProxySettings",permalink:"/api/interfaces/ProxySettings"},next:{title:"QuickInputButton",permalink:"/api/interfaces/QuickInputButton"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Source",id:"source-1",level:4},{value:"id?",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Source",id:"source-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Source",id:"source-4",level:4},{value:"status?",id:"status",level:3},{value:"Source",id:"source-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"error?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"error"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2428",children:"packages/extension-api/src/extension-api.d.ts:2428"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"errorDetails"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"message",children:"message?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2429",children:"packages/extension-api/src/extension-api.d.ts:2429"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2421",children:"packages/extension-api/src/extension-api.d.ts:2421"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progress",children:"progress?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"progress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2423",children:"packages/extension-api/src/extension-api.d.ts:2423"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"progressDetail"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"current",children:"current?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"current"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"total",children:"total?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"total"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2424",children:"packages/extension-api/src/extension-api.d.ts:2424"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2422",children:"packages/extension-api/src/extension-api.d.ts:2422"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stream",children:"stream?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stream"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2420",children:"packages/extension-api/src/extension-api.d.ts:2420"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{85801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const c={},t="Interface: PullEvent",o={id:"interfaces/PullEvent",title:"Interface: PullEvent",description:"Properties",source:"@site/api/interfaces/PullEvent.md",sourceDirName:"interfaces",slug:"/interfaces/PullEvent",permalink:"/api/interfaces/PullEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProxySettings",permalink:"/api/interfaces/ProxySettings"},next:{title:"QuickInputButton",permalink:"/api/interfaces/QuickInputButton"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"error?",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"errorDetails?",id:"errordetails",level:3},{value:"message?",id:"message",level:4},{value:"Source",id:"source-1",level:4},{value:"id?",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"progress?",id:"progress",level:3},{value:"Source",id:"source-3",level:4},{value:"progressDetail?",id:"progressdetail",level:3},{value:"current?",id:"current",level:4},{value:"total?",id:"total",level:4},{value:"Source",id:"source-4",level:4},{value:"status?",id:"status",level:3},{value:"Source",id:"source-5",level:4},{value:"stream?",id:"stream",level:3},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-pullevent",children:"Interface: PullEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"error?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"error"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2428",children:"packages/extension-api/src/extension-api.d.ts:2428"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"errordetails",children:"errorDetails?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"errorDetails"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"message",children:"message?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2429",children:"packages/extension-api/src/extension-api.d.ts:2429"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2421",children:"packages/extension-api/src/extension-api.d.ts:2421"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progress",children:"progress?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"progress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2423",children:"packages/extension-api/src/extension-api.d.ts:2423"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"progressdetail",children:"progressDetail?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"progressDetail"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"current",children:"current?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"current"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"total",children:"total?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"total"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2424",children:"packages/extension-api/src/extension-api.d.ts:2424"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2422",children:"packages/extension-api/src/extension-api.d.ts:2422"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stream",children:"stream?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stream"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2420",children:"packages/extension-api/src/extension-api.d.ts:2420"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/57e01cd5.96e99ef0.js b/assets/js/57e01cd5.0094c231.js similarity index 97% rename from assets/js/57e01cd5.96e99ef0.js rename to assets/js/57e01cd5.0094c231.js index 91449fbbd4c..7787f9fff2b 100644 --- a/assets/js/57e01cd5.96e99ef0.js +++ b/assets/js/57e01cd5.0094c231.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{35312:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=n(24246),s=n(71670);const i={},r="Type alias: StatusBarAlignment",o={id:"type-aliases/StatusBarAlignment",title:"Type alias: StatusBarAlignment",description:"StatusBarAlignment: typeof StatusBarAlignLeft \\| typeof StatusBarAlignRight",source:"@site/api/type-aliases/StatusBarAlignment.md",sourceDirName:"type-aliases",slug:"/type-aliases/StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"},next:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"}},l={},c=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type alias: StatusBarAlignment"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,a.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,a.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1228",children:"packages/extension-api/src/extension-api.d.ts:1228"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>r});var a=n(27378);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{35312:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=n(24246),s=n(71670);const i={},r="Type alias: StatusBarAlignment",o={id:"type-aliases/StatusBarAlignment",title:"Type alias: StatusBarAlignment",description:"StatusBarAlignment: typeof StatusBarAlignLeft \\| typeof StatusBarAlignRight",source:"@site/api/type-aliases/StatusBarAlignment.md",sourceDirName:"type-aliases",slug:"/type-aliases/StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderStatus",permalink:"/api/type-aliases/ProviderStatus"},next:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"}},l={},c=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"type-alias-statusbaralignment",children:"Type alias: StatusBarAlignment"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.strong,{children:"StatusBarAlignment"}),": ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignLeft",children:(0,a.jsx)(t.code,{children:"StatusBarAlignLeft"})})," | ",(0,a.jsx)(t.em,{children:"typeof"})," ",(0,a.jsx)(t.a,{href:"/api/variables/StatusBarAlignRight",children:(0,a.jsx)(t.code,{children:"StatusBarAlignRight"})})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Represents the alignment of status bar items."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1228",children:"packages/extension-api/src/extension-api.d.ts:1228"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>r});var a=n(27378);const s={},i=a.createContext(s);function r(e){const t=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),a.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5a7aef43.9067e20a.js b/assets/js/5a7aef43.b2a3d131.js similarity index 94% rename from assets/js/5a7aef43.9067e20a.js rename to assets/js/5a7aef43.b2a3d131.js index a3f659f1de8..ff16e8debf3 100644 --- a/assets/js/5a7aef43.9067e20a.js +++ b/assets/js/5a7aef43.b2a3d131.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{60991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(24246),o=t(71670);const s={},i="Function: navigateToImages()",c={id:"namespaces/navigation/functions/navigateToImages",title:"Function: navigateToImages()",description:"navigateToImages(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImages.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"},next:{title:"navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4193",children:"packages/extension-api/src/extension-api.d.ts:4193"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(27378);const o={},s=a.createContext(o);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{60991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=t(24246),o=t(71670);const s={},i="Function: navigateToImages()",c={id:"namespaces/navigation/functions/navigateToImages",title:"Function: navigateToImages()",description:"navigateToImages(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToImages.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"},next:{title:"navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"function-navigatetoimages",children:"Function: navigateToImages()"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:"navigateToImages"}),"(): ",(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4193",children:"packages/extension-api/src/extension-api.d.ts:4193"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(27378);const o={},s=a.createContext(o);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5a9a7a02.1624095c.js b/assets/js/5a9a7a02.b6681f2a.js similarity index 85% rename from assets/js/5a9a7a02.1624095c.js rename to assets/js/5a9a7a02.b6681f2a.js index a7adb07525e..01f929f65d2 100644 --- a/assets/js/5a9a7a02.1624095c.js +++ b/assets/js/5a9a7a02.b6681f2a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{74014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const i={},c="Function: deleteVolume()",r={id:"namespaces/containerEngine/functions/deleteVolume",title:"Function: deleteVolume()",description:"deleteVolume(volumeName, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage"},next:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3411",children:"packages/extension-api/src/extension-api.d.ts:3411"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{74014:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const c={},i="Function: deleteVolume()",r={id:"namespaces/containerEngine/functions/deleteVolume",title:"Function: deleteVolume()",description:"deleteVolume(volumeName, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/deleteVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteImage",permalink:"/api/namespaces/containerEngine/functions/deleteImage"},next:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-deletevolume",children:"Function: deleteVolume()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"deleteVolume"}),"(",(0,s.jsx)(n.code,{children:"volumeName"}),", ",(0,s.jsx)(n.code,{children:"options"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"volumeName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/VolumeDeleteOptions",children:(0,s.jsx)(n.code,{children:"VolumeDeleteOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3411",children:"packages/extension-api/src/extension-api.d.ts:3411"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>i});var s=t(27378);const o={},c=s.createContext(o);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b10a003.54f0e0b3.js b/assets/js/5b10a003.917f04f5.js similarity index 90% rename from assets/js/5b10a003.54f0e0b3.js rename to assets/js/5b10a003.917f04f5.js index 6e3995d49be..98acc7f8e5a 100644 --- a/assets/js/5b10a003.54f0e0b3.js +++ b/assets/js/5b10a003.917f04f5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{40310:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),n=s(71670);const c={},t="Interface: BlkioStats",o={id:"interfaces/BlkioStats",title:"Interface: BlkioStats",description:"Properties",source:"@site/api/interfaces/BlkioStats.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStats",permalink:"/api/interfaces/BlkioStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"},next:{title:"BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Source",id:"source",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Source",id:"source-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Source",id:"source-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Source",id:"source-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Source",id:"source-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Source",id:"source-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Source",id:"source-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"}),"\n",(0,r.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2815",children:"packages/extension-api/src/extension-api.d.ts:2815"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2812",children:"packages/extension-api/src/extension-api.d.ts:2812"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2810",children:"packages/extension-api/src/extension-api.d.ts:2810"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2813",children:"packages/extension-api/src/extension-api.d.ts:2813"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2811",children:"packages/extension-api/src/extension-api.d.ts:2811"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2816",children:"packages/extension-api/src/extension-api.d.ts:2816"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2814",children:"packages/extension-api/src/extension-api.d.ts:2814"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2817",children:"packages/extension-api/src/extension-api.d.ts:2817"})})]})}function h(e={}){const{wrapper:i}={...(0,n.a)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>o,a:()=>t});var r=s(27378);const n={},c=r.createContext(n);function t(e){const i=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),r.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{40310:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),n=s(71670);const c={},t="Interface: BlkioStats",o={id:"interfaces/BlkioStats",title:"Interface: BlkioStats",description:"Properties",source:"@site/api/interfaces/BlkioStats.md",sourceDirName:"interfaces",slug:"/interfaces/BlkioStats",permalink:"/api/interfaces/BlkioStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BlkioStatEntry",permalink:"/api/interfaces/BlkioStatEntry"},next:{title:"BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"io_merged_recursive",id:"io_merged_recursive",level:3},{value:"Source",id:"source",level:4},{value:"io_queue_recursive",id:"io_queue_recursive",level:3},{value:"Source",id:"source-1",level:4},{value:"io_service_bytes_recursive",id:"io_service_bytes_recursive",level:3},{value:"Source",id:"source-2",level:4},{value:"io_service_time_recursive",id:"io_service_time_recursive",level:3},{value:"Source",id:"source-3",level:4},{value:"io_serviced_recursive",id:"io_serviced_recursive",level:3},{value:"Source",id:"source-4",level:4},{value:"io_time_recursive",id:"io_time_recursive",level:3},{value:"Source",id:"source-5",level:4},{value:"io_wait_time_recursive",id:"io_wait_time_recursive",level:3},{value:"Source",id:"source-6",level:4},{value:"sectors_recursive",id:"sectors_recursive",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const i={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(i.h1,{id:"interface-blkiostats",children:"Interface: BlkioStats"}),"\n",(0,r.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(i.h3,{id:"io_merged_recursive",children:"io_merged_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_merged_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2815",children:"packages/extension-api/src/extension-api.d.ts:2815"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_queue_recursive",children:"io_queue_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_queue_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2812",children:"packages/extension-api/src/extension-api.d.ts:2812"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_bytes_recursive",children:"io_service_bytes_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_bytes_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2810",children:"packages/extension-api/src/extension-api.d.ts:2810"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_service_time_recursive",children:"io_service_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_service_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2813",children:"packages/extension-api/src/extension-api.d.ts:2813"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_serviced_recursive",children:"io_serviced_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_serviced_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2811",children:"packages/extension-api/src/extension-api.d.ts:2811"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_time_recursive",children:"io_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2816",children:"packages/extension-api/src/extension-api.d.ts:2816"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"io_wait_time_recursive",children:"io_wait_time_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"io_wait_time_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2814",children:"packages/extension-api/src/extension-api.d.ts:2814"})}),"\n",(0,r.jsx)(i.hr,{}),"\n",(0,r.jsx)(i.h3,{id:"sectors_recursive",children:"sectors_recursive"}),"\n",(0,r.jsxs)(i.blockquote,{children:["\n",(0,r.jsxs)(i.p,{children:[(0,r.jsx)(i.strong,{children:"sectors_recursive"}),": ",(0,r.jsx)(i.a,{href:"/api/interfaces/BlkioStatEntry",children:(0,r.jsx)(i.code,{children:"BlkioStatEntry"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(i.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(i.p,{children:(0,r.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2817",children:"packages/extension-api/src/extension-api.d.ts:2817"})})]})}function h(e={}){const{wrapper:i}={...(0,n.a)(),...e.components};return i?(0,r.jsx)(i,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,i,s)=>{s.d(i,{Z:()=>o,a:()=>t});var r=s(27378);const n={},c=r.createContext(n);function t(e){const i=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function o(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),r.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b7d9ef2.7c8e56ed.js b/assets/js/5b7d9ef2.31b19207.js similarity index 94% rename from assets/js/5b7d9ef2.7c8e56ed.js rename to assets/js/5b7d9ef2.31b19207.js index 7ba5fc6ffad..6bf7a03a291 100644 --- a/assets/js/5b7d9ef2.7c8e56ed.js +++ b/assets/js/5b7d9ef2.31b19207.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{16450:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(24246),s=n(71670);const o={},a="Type alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type alias: KubernetesGeneratorType"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(t.code,{children:'"Compose"'})," | ",(0,r.jsx)(t.code,{children:'"Pod"'})," | ",(0,r.jsx)(t.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1869",children:"packages/extension-api/src/extension-api.d.ts:1869"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var r=n(27378);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{16450:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(24246),s=n(71670);const o={},a="Type alias: KubernetesGeneratorType",i={id:"type-aliases/KubernetesGeneratorType",title:"Type alias: KubernetesGeneratorType",description:'KubernetesGeneratorType: "Compose" \\| "Pod" \\| "Container"',source:"@site/api/type-aliases/KubernetesGeneratorType.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector"},next:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"type-alias-kubernetesgeneratortype",children:"Type alias: KubernetesGeneratorType"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"KubernetesGeneratorType"}),": ",(0,r.jsx)(t.code,{children:'"Compose"'})," | ",(0,r.jsx)(t.code,{children:'"Pod"'})," | ",(0,r.jsx)(t.code,{children:'"Container"'})]}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1869",children:"packages/extension-api/src/extension-api.d.ts:1869"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>a});var r=n(27378);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc09a53.d63c2054.js b/assets/js/5bc09a53.74e17fca.js similarity index 89% rename from assets/js/5bc09a53.d63c2054.js rename to assets/js/5bc09a53.74e17fca.js index 6738a5e1274..e1797495e1d 100644 --- a/assets/js/5bc09a53.d63c2054.js +++ b/assets/js/5bc09a53.74e17fca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{32652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var t=s(24246),i=s(71670);const r={},a="Interface: HealthConfig",c={id:"interfaces/HealthConfig",title:"Interface: HealthConfig",description:"Configuration options for defining a healthcheck for a container.",source:"@site/api/interfaces/HealthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HealthConfig",permalink:"/api/interfaces/HealthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"},next:{title:"HostConfig",permalink:"/api/interfaces/HostConfig"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"Interval?",id:"interval",level:3},{value:"Example",id:"example",level:4},{value:"Source",id:"source",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Source",id:"source-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Source",id:"source-2",level:4},{value:"Test?",id:"test",level:3},{value:"Examples",id:"examples",level:4},{value:"Source",id:"source-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-3",level:4},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2465",children:"packages/extension-api/src/extension-api.d.ts:2465"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"retries",children:"Retries?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Retries"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set retries to 3\nRetries?: 3;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2493",children:"packages/extension-api/src/extension-api.d.ts:2493"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"startperiod",children:"StartPeriod?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"StartPeriod"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set start period to 2 seconds\nStartPeriod?: 2000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2484",children:"packages/extension-api/src/extension-api.d.ts:2484"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"test",children:"Test?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Test"}),": ",(0,t.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The test to perform."}),"\n",(0,t.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Inherit healthcheck from image\nTest?: [];\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Disable healthcheck\nTest?: ["NONE"];\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Execute command in host system\nTest?: ["CMD", "curl", "http://localhost"];\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Podman will execute the command inside the target container and wait for either a "0" or "failure exit" code.\nTest?: ["CMD-SHELL", "curl http://localhost || exit 1"];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2456",children:"packages/extension-api/src/extension-api.d.ts:2456"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"timeout",children:"Timeout?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Timeout"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set timeout to 5 seconds\nTimeout?: 5000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const i={},r=t.createContext(i);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{32652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var t=s(24246),i=s(71670);const r={},c="Interface: HealthConfig",a={id:"interfaces/HealthConfig",title:"Interface: HealthConfig",description:"Configuration options for defining a healthcheck for a container.",source:"@site/api/interfaces/HealthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HealthConfig",permalink:"/api/interfaces/HealthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthCheckResults",permalink:"/api/interfaces/HealthCheckResults"},next:{title:"HostConfig",permalink:"/api/interfaces/HostConfig"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"Interval?",id:"interval",level:3},{value:"Example",id:"example",level:4},{value:"Source",id:"source",level:4},{value:"Retries?",id:"retries",level:3},{value:"Example",id:"example-1",level:4},{value:"Source",id:"source-1",level:4},{value:"StartPeriod?",id:"startperiod",level:3},{value:"Example",id:"example-2",level:4},{value:"Source",id:"source-2",level:4},{value:"Test?",id:"test",level:3},{value:"Examples",id:"examples",level:4},{value:"Source",id:"source-3",level:4},{value:"Timeout?",id:"timeout",level:3},{value:"Example",id:"example-3",level:4},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-healthconfig",children:"Interface: HealthConfig"}),"\n",(0,t.jsxs)(n.p,{children:["Configuration options for defining a healthcheck for a container.\nTo get health check result you can use ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/inspectContainer",children:"containerEngine.inspectContainer"})," and inside the obtained ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerInspectInfo",children:"ContainerInspectInfo"})," you can access the ",(0,t.jsx)(n.code,{children:"Status.Health"})," property containing a ",(0,t.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:"HealthCheckResults"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"interval",children:"Interval?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Interval"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set interval to 1 second\nInterval?: 1000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2465",children:"packages/extension-api/src/extension-api.d.ts:2465"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"retries",children:"Retries?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Retries"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set retries to 3\nRetries?: 3;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2493",children:"packages/extension-api/src/extension-api.d.ts:2493"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"startperiod",children:"StartPeriod?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"StartPeriod"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set start period to 2 seconds\nStartPeriod?: 2000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2484",children:"packages/extension-api/src/extension-api.d.ts:2484"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"test",children:"Test?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Test"}),": ",(0,t.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The test to perform."}),"\n",(0,t.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Inherit healthcheck from image\nTest?: [];\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Disable healthcheck\nTest?: ["NONE"];\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Execute command in host system\nTest?: ["CMD", "curl", "http://localhost"];\n'})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:'// Podman will execute the command inside the target container and wait for either a "0" or "failure exit" code.\nTest?: ["CMD-SHELL", "curl http://localhost || exit 1"];\n'})}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2456",children:"packages/extension-api/src/extension-api.d.ts:2456"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"timeout",children:"Timeout?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"Timeout"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit."}),"\n",(0,t.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"// Set timeout to 5 seconds\nTimeout?: 5000000000;\n"})}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2474",children:"packages/extension-api/src/extension-api.d.ts:2474"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c0f0993.45e8a218.js b/assets/js/5c0f0993.7901905e.js similarity index 94% rename from assets/js/5c0f0993.45e8a218.js rename to assets/js/5c0f0993.7901905e.js index 04b72f3d6cf..b5de581b618 100644 --- a/assets/js/5c0f0993.45e8a218.js +++ b/assets/js/5c0f0993.7901905e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{282:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=r(24246),t=r(71670);const i={},d="Interface: TelemetrySender",c={id:"interfaces/TelemetrySender",title:"Interface: TelemetrySender",description:"The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT",source:"@site/api/interfaces/TelemetrySender.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetrySender",permalink:"/api/interfaces/TelemetrySender",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"},next:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3974",children:"packages/extension-api/src/extension-api.d.ts:3974"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"senderrordata",children:"sendErrorData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendErrorData"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send an error. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error being logged"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Any additional data to be collected with the exception"}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3968",children:"packages/extension-api/src/extension-api.d.ts:3968"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendeventdata",children:"sendEventData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendEventData"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send event data without a stacktrace. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event which you are logging"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A serializable key value pair that is being logged"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3959",children:"packages/extension-api/src/extension-api.d.ts:3959"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>d});var s=r(27378);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{282:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=r(24246),t=r(71670);const i={},d="Interface: TelemetrySender",c={id:"interfaces/TelemetrySender",title:"Interface: TelemetrySender",description:"The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT",source:"@site/api/interfaces/TelemetrySender.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetrySender",permalink:"/api/interfaces/TelemetrySender",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"},next:{title:"ThrottlingData",permalink:"/api/interfaces/ThrottlingData"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"flush()?",id:"flush",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"sendErrorData()",id:"senderrordata",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"sendEventData()",id:"sendeventdata",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrysender",children:"Interface: TelemetrySender"}),"\n",(0,s.jsxs)(n.p,{children:["The telemetry sender is the contract between a telemetry logger and some telemetry service. ",(0,s.jsx)(n.strong,{children:"Note"})," that extensions must NOT\ncall the methods of their sender directly as the logger provides extra guards and cleaning."]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"flush",children:"flush()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"flush"}),"(): ",(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Optional flush function which will give this sender a chance to send any remaining events\nas its ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})," is being disposed"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"void"})," | ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3974",children:"packages/extension-api/src/extension-api.d.ts:3974"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"senderrordata",children:"sendErrorData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendErrorData"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send an error. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error being logged"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Any additional data to be collected with the exception"}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3968",children:"packages/extension-api/src/extension-api.d.ts:3968"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sendeventdata",children:"sendEventData()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"sendEventData"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Function to send event data without a stacktrace. Used within a ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The name of the event which you are logging"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A serializable key value pair that is being logged"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3959",children:"packages/extension-api/src/extension-api.d.ts:3959"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>d});var s=r(27378);const t={},i=s.createContext(t);function d(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5db8318c.e382d954.js b/assets/js/5db8318c.55e0ca8f.js similarity index 84% rename from assets/js/5db8318c.e382d954.js rename to assets/js/5db8318c.55e0ca8f.js index 8c80f2b4d02..043464dc085 100644 --- a/assets/js/5db8318c.e382d954.js +++ b/assets/js/5db8318c.55e0ca8f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{45795:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),a=s(71670);const c={},r="Function: registerCommand()",o={id:"namespaces/commands/functions/registerCommand",title:"Function: registerCommand()",description:"registerCommand(command, callback, thisArg?): Disposable",source:"@site/api/namespaces/commands/functions/registerCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand"},next:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L530",children:"packages/extension-api/src/extension-api.d.ts:530"})})]})}function l(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const a={},c=t.createContext(a);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{45795:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),c=s(71670);const r={},a="Function: registerCommand()",o={id:"namespaces/commands/functions/registerCommand",title:"Function: registerCommand()",description:"registerCommand(command, callback, thisArg?): Disposable",source:"@site/api/namespaces/commands/functions/registerCommand.md",sourceDirName:"namespaces/commands/functions",slug:"/namespaces/commands/functions/registerCommand",permalink:"/api/namespaces/commands/functions/registerCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"executeCommand",permalink:"/api/namespaces/commands/functions/executeCommand"},next:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Throws",id:"throws",level:2},{value:"Source",id:"source",level:2}];function m(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-registercommand",children:"Function: registerCommand()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"registerCommand"}),"(",(0,t.jsx)(n.code,{children:"command"}),", ",(0,t.jsx)(n.code,{children:"callback"}),", ",(0,t.jsx)(n.code,{children:"thisArg"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Define a command, to be executed later, either by calling ",(0,t.jsx)(n.a,{href:"/api/namespaces/commands/functions/executeCommand",children:"commands.executeCommand"})," or by referencing its name in the ",(0,t.jsx)(n.code,{children:"command"})," field of a ",(0,t.jsx)(n.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"command"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the command. The name must be unique over all extensions. It is recommended to prefix this name with the name of the extension, to avoid conflicts with commands from other extensions."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the command to execute"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArg?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The value of ",(0,t.jsx)(n.code,{children:"this"})," provided for the call to callback"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable that unregisters this command when being disposed"}),"\n",(0,t.jsx)(n.h2,{id:"throws",children:"Throws"}),"\n",(0,t.jsx)(n.p,{children:"if a command with the same name is already registered."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L530",children:"packages/extension-api/src/extension-api.d.ts:530"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(m,{...e})}):m(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>a});var t=s(27378);const c={},r=t.createContext(c);function a(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e30269e.1509dff2.js b/assets/js/5e30269e.3f855c2a.js similarity index 97% rename from assets/js/5e30269e.1509dff2.js rename to assets/js/5e30269e.3f855c2a.js index 2387375fa07..23d23efa5f3 100644 --- a/assets/js/5e30269e.1509dff2.js +++ b/assets/js/5e30269e.3f855c2a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{38743:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=n(24246),r=n(71670);const i={},o="Type alias: ProviderStatus",a={id:"type-aliases/ProviderStatus",title:"Type alias: ProviderStatus",description:'ProviderStatus: "not-installed" \\| "installed" \\| "configuring" \\| "configured" \\| "ready" \\| "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "error" \\| "unknown"',source:"@site/api/type-aliases/ProviderStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderStatus",permalink:"/api/type-aliases/ProviderStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"},next:{title:"StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type alias: ProviderStatus"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,s.jsx)(t.code,{children:'"not-installed"'})," | ",(0,s.jsx)(t.code,{children:'"installed"'})," | ",(0,s.jsx)(t.code,{children:'"configuring"'})," | ",(0,s.jsx)(t.code,{children:'"configured"'})," | ",(0,s.jsx)(t.code,{children:'"ready"'})," | ",(0,s.jsx)(t.code,{children:'"started"'})," | ",(0,s.jsx)(t.code,{children:'"stopped"'})," | ",(0,s.jsx)(t.code,{children:'"starting"'})," | ",(0,s.jsx)(t.code,{children:'"stopping"'})," | ",(0,s.jsx)(t.code,{children:'"error"'})," | ",(0,s.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L202",children:"packages/extension-api/src/extension-api.d.ts:202"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var s=n(27378);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{38743:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=n(24246),r=n(71670);const i={},o="Type alias: ProviderStatus",a={id:"type-aliases/ProviderStatus",title:"Type alias: ProviderStatus",description:'ProviderStatus: "not-installed" \\| "installed" \\| "configuring" \\| "configured" \\| "ready" \\| "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "error" \\| "unknown"',source:"@site/api/type-aliases/ProviderStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderStatus",permalink:"/api/type-aliases/ProviderStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"},next:{title:"StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-providerstatus",children:"Type alias: ProviderStatus"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"ProviderStatus"}),": ",(0,s.jsx)(t.code,{children:'"not-installed"'})," | ",(0,s.jsx)(t.code,{children:'"installed"'})," | ",(0,s.jsx)(t.code,{children:'"configuring"'})," | ",(0,s.jsx)(t.code,{children:'"configured"'})," | ",(0,s.jsx)(t.code,{children:'"ready"'})," | ",(0,s.jsx)(t.code,{children:'"started"'})," | ",(0,s.jsx)(t.code,{children:'"stopped"'})," | ",(0,s.jsx)(t.code,{children:'"starting"'})," | ",(0,s.jsx)(t.code,{children:'"stopping"'})," | ",(0,s.jsx)(t.code,{children:'"error"'})," | ",(0,s.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L202",children:"packages/extension-api/src/extension-api.d.ts:202"})})]})}function p(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var s=n(27378);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e486140.984c4bbe.js b/assets/js/5e486140.984c4bbe.js deleted file mode 100644 index e8f10f3ef18..00000000000 --- a/assets/js/5e486140.984c4bbe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{12922:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: listPods()",r={id:"namespaces/containerEngine/functions/listPods",title:"Function: listPods()",description:"listPods(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listPods.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listPods",permalink:"/api/namespaces/containerEngine/functions/listPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"},next:{title:"listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"listPods"}),"(): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(e.code,{children:"PodInfo"})}),"[]>"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})})]})}function u(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(l,{...n})}):l(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(n){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:c(n.components),t.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e486140.99524307.js b/assets/js/5e486140.99524307.js new file mode 100644 index 00000000000..be6c8c9a30c --- /dev/null +++ b/assets/js/5e486140.99524307.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{12922:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: listPods()",r={id:"namespaces/containerEngine/functions/listPods",title:"Function: listPods()",description:"listPods(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listPods.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listPods",permalink:"/api/namespaces/containerEngine/functions/listPods",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"},next:{title:"listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listpods",children:"Function: listPods()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listPods"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(n.code,{children:"PodInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/PodInfo",children:(0,t.jsx)(n.code,{children:"PodInfo"})}),"[]>"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3420",children:"packages/extension-api/src/extension-api.d.ts:3420"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e8fbcdf.de1f9805.js b/assets/js/5e8fbcdf.e9a40a25.js similarity index 85% rename from assets/js/5e8fbcdf.de1f9805.js rename to assets/js/5e8fbcdf.e9a40a25.js index 0bdcac3bf4b..4a100965e93 100644 --- a/assets/js/5e8fbcdf.de1f9805.js +++ b/assets/js/5e8fbcdf.e9a40a25.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28992:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: BuildImageOptions",d={id:"interfaces/BuildImageOptions",title:"Interface: BuildImageOptions",description:"Properties",source:"@site/api/interfaces/BuildImageOptions.md",sourceDirName:"interfaces",slug:"/interfaces/BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BlkioStats",permalink:"/api/interfaces/BlkioStats"},next:{title:"CPUStats",permalink:"/api/interfaces/CPUStats"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Source",id:"source",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Source",id:"source-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Source",id:"source-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Source",id:"source-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Source",id:"source-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Source",id:"source-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Source",id:"source-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Source",id:"source-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Source",id:"source-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Source",id:"source-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Source",id:"source-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Source",id:"source-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Source",id:"source-18",level:4},{value:"q?",id:"q",level:3},{value:"Source",id:"source-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Source",id:"source-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Source",id:"source-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Source",id:"source-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Source",id:"source-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Source",id:"source-24",level:4},{value:"target?",id:"target",level:3},{value:"Source",id:"source-25",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"abortController"}),": ",(0,i.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2945",children:"packages/extension-api/src/extension-api.d.ts:2945"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"buildargs",children:"buildargs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"buildargs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the\nbuildargs as the environment context for commands run via the ",(0,i.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,i.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,i.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,i.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3029",children:"packages/extension-api/src/extension-api.d.ts:3029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cachefrom"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"containerFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2925",children:"packages/extension-api/src/extension-api.d.ts:2925"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"cpuperiod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpuperiod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3015",children:"packages/extension-api/src/extension-api.d.ts:3015"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpuquota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3020",children:"packages/extension-api/src/extension-api.d.ts:3020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpusetcpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3010",children:"packages/extension-api/src/extension-api.d.ts:3010"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpushares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3005",children:"packages/extension-api/src/extension-api.d.ts:3005"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"extrahosts"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2950",children:"packages/extension-api/src/extension-api.d.ts:2950"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"forcerm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3044",children:"packages/extension-api/src/extension-api.d.ts:3044"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set memory limit for build."}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"memswap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3000",children:"packages/extension-api/src/extension-api.d.ts:3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"networkmode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,i.jsx)(n.code,{children:"bridge"}),",\n",(0,i.jsx)(n.code,{children:"host"}),", ",(0,i.jsx)(n.code,{children:"none"}),", and ",(0,i.jsx)(n.code,{children:"container:"}),". Any other value is taken as a custom network's name or ID\nto which this container should connect to."]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3051",children:"packages/extension-api/src/extension-api.d.ts:3051"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"nocache"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"outputs"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3065",children:"packages/extension-api/src/extension-api.d.ts:3065"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host"}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2935",children:"packages/extension-api/src/extension-api.d.ts:2935"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)"}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2940",children:"packages/extension-api/src/extension-api.d.ts:2940"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pull",children:"pull?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"q",children:"q?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"q"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2966",children:"packages/extension-api/src/extension-api.d.ts:2966"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remote",children:"remote?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"remote"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file\u2019s contents are\nplaced into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the\nfile is downloaded by the daemon and the contents therein used as the context for the build. If the URI points\nto a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path\ninside the tarball."}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rm",children:"rm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"rm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: true"}),"\n",(0,i.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2983",children:"packages/extension-api/src/extension-api.d.ts:2983"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"shmsize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Size of ",(0,i.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3034",children:"packages/extension-api/src/extension-api.d.ts:3034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"squash",children:"squash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"squash"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3039",children:"packages/extension-api/src/extension-api.d.ts:3039"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tag",children:"tag?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2930",children:"packages/extension-api/src/extension-api.d.ts:2930"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"target?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"Target build stage"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28992:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: BuildImageOptions",t={id:"interfaces/BuildImageOptions",title:"Interface: BuildImageOptions",description:"Properties",source:"@site/api/interfaces/BuildImageOptions.md",sourceDirName:"interfaces",slug:"/interfaces/BuildImageOptions",permalink:"/api/interfaces/BuildImageOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"BlkioStats",permalink:"/api/interfaces/BlkioStats"},next:{title:"CPUStats",permalink:"/api/interfaces/CPUStats"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"abortController?",id:"abortcontroller",level:3},{value:"Source",id:"source",level:4},{value:"buildargs?",id:"buildargs",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-1",level:4},{value:"cachefrom?",id:"cachefrom",level:3},{value:"Source",id:"source-2",level:4},{value:"containerFile?",id:"containerfile",level:3},{value:"Source",id:"source-3",level:4},{value:"cpuperiod?",id:"cpuperiod",level:3},{value:"Source",id:"source-4",level:4},{value:"cpuquota?",id:"cpuquota",level:3},{value:"Source",id:"source-5",level:4},{value:"cpusetcpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-6",level:4},{value:"cpushares?",id:"cpushares",level:3},{value:"Source",id:"source-7",level:4},{value:"extrahosts?",id:"extrahosts",level:3},{value:"Source",id:"source-8",level:4},{value:"forcerm?",id:"forcerm",level:3},{value:"Source",id:"source-9",level:4},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-10",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-11",level:4},{value:"memswap?",id:"memswap",level:3},{value:"Source",id:"source-12",level:4},{value:"networkmode?",id:"networkmode",level:3},{value:"Source",id:"source-13",level:4},{value:"nocache?",id:"nocache",level:3},{value:"Source",id:"source-14",level:4},{value:"outputs?",id:"outputs",level:3},{value:"Source",id:"source-15",level:4},{value:"platform?",id:"platform",level:3},{value:"Source",id:"source-16",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-17",level:4},{value:"pull?",id:"pull",level:3},{value:"Source",id:"source-18",level:4},{value:"q?",id:"q",level:3},{value:"Source",id:"source-19",level:4},{value:"remote?",id:"remote",level:3},{value:"Source",id:"source-20",level:4},{value:"rm?",id:"rm",level:3},{value:"Source",id:"source-21",level:4},{value:"shmsize?",id:"shmsize",level:3},{value:"Source",id:"source-22",level:4},{value:"squash?",id:"squash",level:3},{value:"Source",id:"source-23",level:4},{value:"tag?",id:"tag",level:3},{value:"Source",id:"source-24",level:4},{value:"target?",id:"target",level:3},{value:"Source",id:"source-25",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"abortController"}),": ",(0,i.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2945",children:"packages/extension-api/src/extension-api.d.ts:2945"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"buildargs",children:"buildargs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"buildargs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the\nbuildargs as the environment context for commands run via the ",(0,i.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,i.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,i.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,i.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,i.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3029",children:"packages/extension-api/src/extension-api.d.ts:3029"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cachefrom"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2971",children:"packages/extension-api/src/extension-api.d.ts:2971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"containerFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2925",children:"packages/extension-api/src/extension-api.d.ts:2925"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"cpuperiod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpuperiod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3015",children:"packages/extension-api/src/extension-api.d.ts:3015"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpuquota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3020",children:"packages/extension-api/src/extension-api.d.ts:3020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpusetcpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3010",children:"packages/extension-api/src/extension-api.d.ts:3010"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cpushares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3005",children:"packages/extension-api/src/extension-api.d.ts:3005"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"extrahosts"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2950",children:"packages/extension-api/src/extension-api.d.ts:2950"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"forcerm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3044",children:"packages/extension-api/src/extension-api.d.ts:3044"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set memory limit for build."}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"memswap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3000",children:"packages/extension-api/src/extension-api.d.ts:3000"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"networkmode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,i.jsx)(n.code,{children:"bridge"}),",\n",(0,i.jsx)(n.code,{children:"host"}),", ",(0,i.jsx)(n.code,{children:"none"}),", and ",(0,i.jsx)(n.code,{children:"container:"}),". Any other value is taken as a custom network's name or ID\nto which this container should connect to."]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3051",children:"packages/extension-api/src/extension-api.d.ts:3051"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"nocache"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3072",children:"packages/extension-api/src/extension-api.d.ts:3072"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"outputs"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3065",children:"packages/extension-api/src/extension-api.d.ts:3065"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"platform?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host"}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2935",children:"packages/extension-api/src/extension-api.d.ts:2935"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)"}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2940",children:"packages/extension-api/src/extension-api.d.ts:2940"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pull",children:"pull?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pull"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"q",children:"q?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"q"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: false"}),"\n",(0,i.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2966",children:"packages/extension-api/src/extension-api.d.ts:2966"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"remote",children:"remote?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"remote"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file\u2019s contents are\nplaced into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the\nfile is downloaded by the daemon and the contents therein used as the context for the build. If the URI points\nto a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path\ninside the tarball."}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2959",children:"packages/extension-api/src/extension-api.d.ts:2959"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rm",children:"rm?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"rm"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Default: true"}),"\n",(0,i.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2983",children:"packages/extension-api/src/extension-api.d.ts:2983"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"shmsize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Size of ",(0,i.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3034",children:"packages/extension-api/src/extension-api.d.ts:3034"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"squash",children:"squash?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"squash"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3039",children:"packages/extension-api/src/extension-api.d.ts:3039"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tag",children:"tag?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tag"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2930",children:"packages/extension-api/src/extension-api.d.ts:2930"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"target?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:'Default: ""'}),"\n",(0,i.jsx)(n.p,{children:"Target build stage"}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3058",children:"packages/extension-api/src/extension-api.d.ts:3058"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/604e05e4.187f5bf6.js b/assets/js/604e05e4.1a891fa4.js similarity index 79% rename from assets/js/604e05e4.187f5bf6.js rename to assets/js/604e05e4.1a891fa4.js index e92e3939302..5ae35239920 100644 --- a/assets/js/604e05e4.187f5bf6.js +++ b/assets/js/604e05e4.1a891fa4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{28105:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: NetworkInfo",d={id:"interfaces/NetworkInfo",title:"Interface: NetworkInfo",description:"Properties",source:"@site/api/interfaces/NetworkInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInfo",permalink:"/api/interfaces/NetworkInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"},next:{title:"NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Source",id:"source-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Source",id:"source-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Source",id:"source-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Source",id:"source-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Source",id:"source-8",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2065",children:"packages/extension-api/src/extension-api.d.ts:2065"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2067",children:"packages/extension-api/src/extension-api.d.ts:2067"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2068",children:"packages/extension-api/src/extension-api.d.ts:2068"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2072",children:"packages/extension-api/src/extension-api.d.ts:2072"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2073",children:"packages/extension-api/src/extension-api.d.ts:2073"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2063",children:"packages/extension-api/src/extension-api.d.ts:2063"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2069",children:"packages/extension-api/src/extension-api.d.ts:2069"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2070",children:"packages/extension-api/src/extension-api.d.ts:2070"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2071",children:"packages/extension-api/src/extension-api.d.ts:2071"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2074",children:"packages/extension-api/src/extension-api.d.ts:2074"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2066",children:"packages/extension-api/src/extension-api.d.ts:2066"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{28105:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: NetworkInfo",t={id:"interfaces/NetworkInfo",title:"Interface: NetworkInfo",description:"Properties",source:"@site/api/interfaces/NetworkInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInfo",permalink:"/api/interfaces/NetworkInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"},next:{title:"NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source-1",level:4},{value:"Gateway",id:"gateway",level:3},{value:"Source",id:"source-2",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:3},{value:"Source",id:"source-3",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-4",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-5",level:4},{value:"IPAddress",id:"ipaddress",level:3},{value:"Source",id:"source-6",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:3},{value:"Source",id:"source-7",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:3},{value:"Source",id:"source-8",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-9",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-10",level:4},{value:"NetworkID",id:"networkid",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2065",children:"packages/extension-api/src/extension-api.d.ts:2065"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2067",children:"packages/extension-api/src/extension-api.d.ts:2067"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2068",children:"packages/extension-api/src/extension-api.d.ts:2068"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2072",children:"packages/extension-api/src/extension-api.d.ts:2072"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2073",children:"packages/extension-api/src/extension-api.d.ts:2073"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2063",children:"packages/extension-api/src/extension-api.d.ts:2063"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2069",children:"packages/extension-api/src/extension-api.d.ts:2069"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2070",children:"packages/extension-api/src/extension-api.d.ts:2070"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2071",children:"packages/extension-api/src/extension-api.d.ts:2071"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2064",children:"packages/extension-api/src/extension-api.d.ts:2064"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2074",children:"packages/extension-api/src/extension-api.d.ts:2074"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2066",children:"packages/extension-api/src/extension-api.d.ts:2066"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/60c82955.30ff376a.js b/assets/js/60c82955.428ff5b2.js similarity index 86% rename from assets/js/60c82955.30ff376a.js rename to assets/js/60c82955.428ff5b2.js index 28be1b245f1..1a0cf416052 100644 --- a/assets/js/60c82955.30ff376a.js +++ b/assets/js/60c82955.428ff5b2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{80042:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>t});var i=n(24246),r=n(71670);const d={},c="Interface: CliTool",o={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},l={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Source",id:"source-1",level:4},{value:"id",id:"id-1",level:3},{value:"Source",id:"source-2",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-6",level:4},{value:"state",id:"state",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-clitool",children:"Interface: CliTool"}),"\n",(0,i.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"displayName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4076",children:"packages/extension-api/src/extension-api.d.ts:4076"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"extensionInfo"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"label",children:"label"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"label"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4080",children:"packages/extension-api/src/extension-api.d.ts:4080"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4074",children:"packages/extension-api/src/extension-api.d.ts:4074"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"images"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(s.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4079",children:"packages/extension-api/src/extension-api.d.ts:4079"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4077",children:"packages/extension-api/src/extension-api.d.ts:4077"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"name"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4075",children:"packages/extension-api/src/extension-api.d.ts:4075"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateVersion"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"<",(0,i.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4086",children:"packages/extension-api/src/extension-api.d.ts:4086"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"state",children:"state"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"state"}),": ",(0,i.jsx)(s.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})," . ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(s.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"registerUpdate"}),"(",(0,i.jsx)(s.code,{children:"update"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"update"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdate",children:(0,i.jsx)(s.code,{children:"CliToolUpdate"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4089",children:"packages/extension-api/src/extension-api.d.ts:4089"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"updateVersion"}),"(",(0,i.jsx)(s.code,{children:"version"}),"): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"version"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,i.jsx)(s.code,{children:"CliToolUpdateOptions"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4085",children:"packages/extension-api/src/extension-api.d.ts:4085"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},d=i.createContext(r);function c(e){const s=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{80042:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>t});var i=n(24246),r=n(71670);const c={},d="Interface: CliTool",o={id:"interfaces/CliTool",title:"Interface: CliTool",description:"Extends",source:"@site/api/interfaces/CliTool.md",sourceDirName:"interfaces",slug:"/interfaces/CliTool",permalink:"/api/interfaces/CliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"},next:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"}},l={},t=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"displayName",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"extensionInfo",id:"extensioninfo",level:3},{value:"id",id:"id",level:4},{value:"label",id:"label",level:4},{value:"Source",id:"source-1",level:4},{value:"id",id:"id-1",level:3},{value:"Source",id:"source-2",level:4},{value:"images",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"markdownDescription",id:"markdowndescription",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidUpdateVersion",id:"ondidupdateversion",level:3},{value:"Source",id:"source-6",level:4},{value:"state",id:"state",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-8",level:4},{value:"registerUpdate()",id:"registerupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"updateVersion()",id:"updateversion",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-clitool",children:"Interface: CliTool"}),"\n",(0,i.jsx)(s.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"displayname",children:"displayName"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"displayName"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4076",children:"packages/extension-api/src/extension-api.d.ts:4076"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"extensioninfo",children:"extensionInfo"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"extensionInfo"}),": ",(0,i.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"id",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"label",children:"label"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"label"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4080",children:"packages/extension-api/src/extension-api.d.ts:4080"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"id-1",children:"id"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"id"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4074",children:"packages/extension-api/src/extension-api.d.ts:4074"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"images",children:"images"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"images"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(s.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4079",children:"packages/extension-api/src/extension-api.d.ts:4079"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"markdowndescription",children:"markdownDescription"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4077",children:"packages/extension-api/src/extension-api.d.ts:4077"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"name"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4075",children:"packages/extension-api/src/extension-api.d.ts:4075"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidupdateversion",children:"onDidUpdateVersion"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateVersion"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"<",(0,i.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4086",children:"packages/extension-api/src/extension-api.d.ts:4086"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"state",children:"state"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"state"}),": ",(0,i.jsx)(s.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4078",children:"packages/extension-api/src/extension-api.d.ts:4078"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})," . ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(s.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"registerupdate",children:"registerUpdate()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"registerUpdate"}),"(",(0,i.jsx)(s.code,{children:"update"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"update"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdate",children:(0,i.jsx)(s.code,{children:"CliToolUpdate"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4089",children:"packages/extension-api/src/extension-api.d.ts:4089"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"updateversion",children:"updateVersion()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"updateVersion"}),"(",(0,i.jsx)(s.code,{children:"version"}),"): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"version"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/CliToolUpdateOptions",children:(0,i.jsx)(s.code,{children:"CliToolUpdateOptions"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4085",children:"packages/extension-api/src/extension-api.d.ts:4085"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>d});var i=n(27378);const r={},c=i.createContext(r);function d(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/610f2c47.faa47b1d.js b/assets/js/610f2c47.ade9037d.js similarity index 98% rename from assets/js/610f2c47.faa47b1d.js rename to assets/js/610f2c47.ade9037d.js index bee8871ad2e..4d1c37febd6 100644 --- a/assets/js/610f2c47.faa47b1d.js +++ b/assets/js/610f2c47.ade9037d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{36704:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(24246),o=s(71670);const i={},r="Function: showInputBox()",c={id:"namespaces/window/functions/showInputBox",title:"Function: showInputBox()",description:"showInputBox(options?, token?): Promise\\",source:"@site/api/namespaces/window/functions/showInputBox.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInputBox",permalink:"/api/namespaces/window/functions/showInputBox",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1742",children:"packages/extension-api/src/extension-api.d.ts:1742"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{36704:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=s(24246),o=s(71670);const i={},r="Function: showInputBox()",c={id:"namespaces/window/functions/showInputBox",title:"Function: showInputBox()",description:"showInputBox(options?, token?): Promise\\",source:"@site/api/namespaces/window/functions/showInputBox.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInputBox",permalink:"/api/namespaces/window/functions/showInputBox",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"},next:{title:"showNotification",permalink:"/api/namespaces/window/functions/showNotification"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-showinputbox",children:"Function: showInputBox()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"showInputBox"}),"(",(0,t.jsx)(n.code,{children:"options"}),"?, ",(0,t.jsx)(n.code,{children:"token"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Opens an input box to ask the user for input."}),"\n",(0,t.jsxs)(n.p,{children:["The returned value will be ",(0,t.jsx)(n.code,{children:"undefined"})," if the input box was canceled (e.g. pressing ESC). Otherwise the\nreturned value will be the string typed by the user or an empty string if the user did not type\nanything but dismissed the input box with OK."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions",children:(0,t.jsx)(n.code,{children:"InputBoxOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Configures the behavior of the input box."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"token?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,t.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,t.jsx)(n.p,{children:"A token that can be used to signal cancellation."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["A promise that resolves to a string the user provided or to ",(0,t.jsx)(n.code,{children:"undefined"})," in case of dismissal."]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1742",children:"packages/extension-api/src/extension-api.d.ts:1742"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var t=s(27378);const o={},i=t.createContext(o);function r(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/612345e6.1842021b.js b/assets/js/612345e6.344c2e2a.js similarity index 95% rename from assets/js/612345e6.1842021b.js rename to assets/js/612345e6.344c2e2a.js index bafd999d28d..34adb6ddff4 100644 --- a/assets/js/612345e6.1842021b.js +++ b/assets/js/612345e6.344c2e2a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{88795:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContribution()",r={id:"namespaces/navigation/functions/navigateToContribution",title:"Function: navigateToContribution()",description:"navigateToContribution(name): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContribution.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4208",children:"packages/extension-api/src/extension-api.d.ts:4208"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{88795:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContribution()",r={id:"namespaces/navigation/functions/navigateToContribution",title:"Function: navigateToContribution()",description:"navigateToContribution(name): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContribution.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"},next:{title:"navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontribution",children:"Function: navigateToContribution()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContribution"}),"(",(0,i.jsx)(e.code,{children:"name"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4208",children:"packages/extension-api/src/extension-api.d.ts:4208"})})]})}function l(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const o={},a=i.createContext(o);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/62e21724.7a9df391.js b/assets/js/62e21724.36eeec1f.js similarity index 88% rename from assets/js/62e21724.7a9df391.js rename to assets/js/62e21724.36eeec1f.js index 5506c757729..c37a9d0be97 100644 --- a/assets/js/62e21724.7a9df391.js +++ b/assets/js/62e21724.36eeec1f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{48526:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var i=t(24246),o=t(71670);const c={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Source",id:"source",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-quickinputbutton",children:"Interface: QuickInputButton"}),"\n",(0,i.jsx)(n.p,{children:"Button for an action in a QuickPick or InputBox."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L965",children:"packages/extension-api/src/extension-api.d.ts:965"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L970",children:"packages/extension-api/src/extension-api.d.ts:970"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{48526:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var i=t(24246),o=t(71670);const c={},r="Interface: QuickInputButton",s={id:"interfaces/QuickInputButton",title:"Interface: QuickInputButton",description:"Button for an action in a QuickPick or InputBox.",source:"@site/api/interfaces/QuickInputButton.md",sourceDirName:"interfaces",slug:"/interfaces/QuickInputButton",permalink:"/api/interfaces/QuickInputButton",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"},next:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"iconPath",id:"iconpath",level:3},{value:"Source",id:"source",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-1",level:4}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-quickinputbutton",children:"Interface: QuickInputButton"}),"\n",(0,i.jsx)(n.p,{children:"Button for an action in a QuickPick or InputBox."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the button."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L965",children:"packages/extension-api/src/extension-api.d.ts:965"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional tooltip."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L970",children:"packages/extension-api/src/extension-api.d.ts:970"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var i=t(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/640277b9.698dc297.js b/assets/js/640277b9.392ed67f.js similarity index 95% rename from assets/js/640277b9.698dc297.js rename to assets/js/640277b9.392ed67f.js index 6c4053323d0..0901e7e5bb8 100644 --- a/assets/js/640277b9.698dc297.js +++ b/assets/js/640277b9.392ed67f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{49161:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise \\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1835",children:"packages/extension-api/src/extension-api.d.ts:1835"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},o=i.createContext(t);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{49161:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: listWebviews()",r={id:"namespaces/window/functions/listWebviews",title:"Function: listWebviews()",description:"listWebviews(): Promise \\",source:"@site/api/namespaces/window/functions/listWebviews.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/listWebviews",permalink:"/api/namespaces/window/functions/listWebviews",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"},next:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listwebviews",children:"Function: listWebviews()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listWebviews"}),"(): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewInfo",children:(0,i.jsx)(n.code,{children:"WebviewInfo"})}),"[]>"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1835",children:"packages/extension-api/src/extension-api.d.ts:1835"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var i=s(27378);const t={},o=i.createContext(t);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/64134c03.586274fc.js b/assets/js/64134c03.587ee3ee.js similarity index 77% rename from assets/js/64134c03.586274fc.js rename to assets/js/64134c03.587ee3ee.js index e2d311875fb..308b7380f37 100644 --- a/assets/js/64134c03.586274fc.js +++ b/assets/js/64134c03.587ee3ee.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{34807:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="Function: isEnabled()",a={id:"namespaces/proxy/functions/isEnabled",title:"Function: isEnabled()",description:"isEnabled(): boolean",source:"@site/api/namespaces/proxy/functions/isEnabled.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings"},next:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"}},r={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L617",children:"packages/extension-api/src/extension-api.d.ts:617"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{34807:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="Function: isEnabled()",r={id:"namespaces/proxy/functions/isEnabled",title:"Function: isEnabled()",description:"isEnabled(): boolean",source:"@site/api/namespaces/proxy/functions/isEnabled.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings"},next:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-isenabled",children:"Function: isEnabled()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isEnabled"}),"(): ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L617",children:"packages/extension-api/src/extension-api.d.ts:617"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6477cdc2.78d0fc54.js b/assets/js/6477cdc2.98b636f6.js similarity index 98% rename from assets/js/6477cdc2.78d0fc54.js rename to assets/js/6477cdc2.98b636f6.js index 9072ca5a356..5e3866c5cee 100644 --- a/assets/js/6477cdc2.78d0fc54.js +++ b/assets/js/6477cdc2.98b636f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{10966:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=r(24246),s=r(71670);const o={},c="Function: createTelemetryLogger()",i={id:"namespaces/env/functions/createTelemetryLogger",title:"Function: createTelemetryLogger()",description:"createTelemetryLogger(sender?, options?): TelemetryLogger",source:"@site/api/namespaces/env/functions/createTelemetryLogger.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isWindows",permalink:"/api/namespaces/env/variables/isWindows"},next:{title:"onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3752",children:"packages/extension-api/src/extension-api.d.ts:3752"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>c});var t=r(27378);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{10966:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var t=r(24246),s=r(71670);const o={},c="Function: createTelemetryLogger()",i={id:"namespaces/env/functions/createTelemetryLogger",title:"Function: createTelemetryLogger()",description:"createTelemetryLogger(sender?, options?): TelemetryLogger",source:"@site/api/namespaces/env/functions/createTelemetryLogger.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isWindows",permalink:"/api/namespaces/env/variables/isWindows"},next:{title:"onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createtelemetrylogger",children:"Function: createTelemetryLogger()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createTelemetryLogger"}),"(",(0,t.jsx)(n.code,{children:"sender"}),"?, ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Creates a new ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"telemetry logger"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"sender?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:(0,t.jsx)(n.code,{children:"TelemetrySender"})})]}),"\n",(0,t.jsx)(n.p,{children:"The telemetry sender that is used by the telemetry logger."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLoggerOptions",children:(0,t.jsx)(n.code,{children:"TelemetryLoggerOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"Options for the telemetry logger."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,t.jsx)(n.code,{children:"TelemetryLogger"})})}),"\n",(0,t.jsx)(n.p,{children:"A new telemetry logger"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3752",children:"packages/extension-api/src/extension-api.d.ts:3752"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>i,a:()=>c});var t=r(27378);const s={},o=t.createContext(s);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6494b798.9dcfd3a1.js b/assets/js/6494b798.21a10cdc.js similarity index 84% rename from assets/js/6494b798.9dcfd3a1.js rename to assets/js/6494b798.21a10cdc.js index e09d879fa30..d91f9a806f0 100644 --- a/assets/js/6494b798.9dcfd3a1.js +++ b/assets/js/6494b798.21a10cdc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{25093:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var t=s(24246),i=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isWindows"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,t.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Windows.\nIf the value is false, it means the current system is not Windows."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3715",children:"packages/extension-api/src/extension-api.d.ts:3715"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);const i={},a=t.createContext(i);function o(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{25093:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var t=s(24246),i=s(71670);const a={},o="Variable: isWindows",r={id:"namespaces/env/variables/isWindows",title:"Variable: isWindows",description:"const isWindows: boolean",source:"@site/api/namespaces/env/variables/isWindows.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isWindows",permalink:"/api/namespaces/env/variables/isWindows",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"},next:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-iswindows",children:"Variable: isWindows"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isWindows"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Flag indicating whether we are running on the Windows operating system."}),"\n",(0,t.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Windows.\nIf the value is false, it means the current system is not Windows."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3715",children:"packages/extension-api/src/extension-api.d.ts:3715"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var t=s(27378);const i={},a=t.createContext(i);function o(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/64bd32f2.2f5c5bc7.js b/assets/js/64bd32f2.2f5c5bc7.js new file mode 100644 index 00000000000..13c5b7a7dd4 --- /dev/null +++ b/assets/js/64bd32f2.2f5c5bc7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{12601:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Function: inspectManifest()",o={id:"namespaces/containerEngine/functions/inspectManifest",title:"Function: inspectManifest()",description:"inspectManifest(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/inspectManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"},next:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"inspectManifest"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"id"}),"): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,t.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,t.jsx)(n.code,{children:"ManifestInspectInfo"})}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3426",children:"packages/extension-api/src/extension-api.d.ts:3426"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/64bd32f2.6987e39f.js b/assets/js/64bd32f2.6987e39f.js deleted file mode 100644 index 54e49f0d6b6..00000000000 --- a/assets/js/64bd32f2.6987e39f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{12601:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Function: inspectManifest()",o={id:"namespaces/containerEngine/functions/inspectManifest",title:"Function: inspectManifest()",description:"inspectManifest(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/inspectManifest.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"},next:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-inspectmanifest",children:"Function: inspectManifest()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectManifest"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,t.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ManifestInspectInfo",children:(0,t.jsx)(e.code,{children:"ManifestInspectInfo"})}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3426",children:"packages/extension-api/src/extension-api.d.ts:3426"})})]})}function l(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(n){const e=t.useContext(c);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function o(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:r(n.components),t.createElement(c.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/67386898.1d0a8d0b.js b/assets/js/67386898.ed23d11a.js similarity index 91% rename from assets/js/67386898.1d0a8d0b.js rename to assets/js/67386898.ed23d11a.js index 0398b10da1a..6ce228036b7 100644 --- a/assets/js/67386898.1d0a8d0b.js +++ b/assets/js/67386898.ed23d11a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{86600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: VolumeCreateOptions",c={id:"interfaces/VolumeCreateOptions",title:"Interface: VolumeCreateOptions",description:"Properties",source:"@site/api/interfaces/VolumeCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"},next:{title:"VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3159",children:"packages/extension-api/src/extension-api.d.ts:3159"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{86600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: VolumeCreateOptions",c={id:"interfaces/VolumeCreateOptions",title:"Interface: VolumeCreateOptions",description:"Properties",source:"@site/api/interfaces/VolumeCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"},next:{title:"VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-volumecreateoptions",children:"Interface: VolumeCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3159",children:"packages/extension-api/src/extension-api.d.ts:3159"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6763d4e0.d5ac2f59.js b/assets/js/6763d4e0.ec4caa67.js similarity index 82% rename from assets/js/6763d4e0.d5ac2f59.js rename to assets/js/6763d4e0.ec4caa67.js index 4fb6b6ed407..cf2dcbed282 100644 --- a/assets/js/6763d4e0.d5ac2f59.js +++ b/assets/js/6763d4e0.ec4caa67.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{35287:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},r="Function: info()",c={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise \\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{35287:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var t=i(24246),s=i(71670);const o={},c="Function: info()",r={id:"namespaces/containerEngine/functions/info",title:"Function: info()",description:"info(engineId): Promise \\",source:"@site/api/namespaces/containerEngine/functions/info.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/info",permalink:"/api/namespaces/containerEngine/functions/info",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect"},next:{title:"inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-info",children:"Function: info()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"info"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),"): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,t.jsx)(e.code,{children:"ContainerEngineInfo"})}),">"]}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3381",children:"packages/extension-api/src/extension-api.d.ts:3381"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>r,a:()=>c});var t=i(27378);const s={},o=t.createContext(s);function c(n){const e=t.useContext(o);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),t.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/6774f806.985e86c4.js b/assets/js/6774f806.6577b090.js similarity index 83% rename from assets/js/6774f806.985e86c4.js rename to assets/js/6774f806.6577b090.js index 4f9a64b348f..0f2cec7f3b5 100644 --- a/assets/js/6774f806.985e86c4.js +++ b/assets/js/6774f806.6577b090.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{1797:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>l});var t=i(24246),o=i(71670);const c={},r="Function: pullImage()",s={id:"namespaces/containerEngine/functions/pullImage",title:"Function: pullImage()",description:"pullImage(containerProviderConnection, imageName, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pullImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent"},next:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3358",children:"packages/extension-api/src/extension-api.d.ts:3358"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>r});var t=i(27378);const o={},c=t.createContext(o);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{1797:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var t=i(24246),c=i(71670);const o={},r="Function: pullImage()",s={id:"namespaces/containerEngine/functions/pullImage",title:"Function: pullImage()",description:"pullImage(containerProviderConnection, imageName, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pullImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent"},next:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-pullimage",children:"Function: pullImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"pullImage"}),"(",(0,t.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,t.jsx)(n.code,{children:"imageName"}),", ",(0,t.jsx)(n.code,{children:"callback"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Pull an image from a registry"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,t.jsx)(n.p,{children:"the connection to the local engine to use for pulling the image"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageName"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the name of the image to pull"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"callback"})]}),"\n",(0,t.jsx)(n.p,{children:"the function called when new logs are emitted during the pull operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3358",children:"packages/extension-api/src/extension-api.d.ts:3358"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>r});var t=i(27378);const c={},o=t.createContext(c);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67eba1be.f31923d6.js b/assets/js/67eba1be.f9d3c735.js similarity index 91% rename from assets/js/67eba1be.f31923d6.js rename to assets/js/67eba1be.f9d3c735.js index afe690c6d59..93c062ca1b7 100644 --- a/assets/js/67eba1be.f31923d6.js +++ b/assets/js/67eba1be.f9d3c735.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{61902:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="Interface: Command",c={id:"interfaces/Command",title:"Interface: Command",description:"Represents a reference to a command. Provides a title which",source:"@site/api/interfaces/Command.md",sourceDirName:"interfaces",slug:"/interfaces/Command",permalink:"/api/interfaces/Command",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Clipboard",permalink:"/api/interfaces/Clipboard"},next:{title:"Configuration",permalink:"/api/interfaces/Configuration"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Source",id:"source",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"}),"\n",(0,s.jsx)(n.p,{children:"Represents a reference to a command. Provides a title which\nwill be used to represent a command in the UI and, optionally,\nan array of arguments which will be passed to the command handler\nfunction when invoked."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"arguments"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L55",children:"packages/extension-api/src/extension-api.d.ts:55"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L51",children:"packages/extension-api/src/extension-api.d.ts:51"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"tooltip"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{61902:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const o={},r="Interface: Command",c={id:"interfaces/Command",title:"Interface: Command",description:"Represents a reference to a command. Provides a title which",source:"@site/api/interfaces/Command.md",sourceDirName:"interfaces",slug:"/interfaces/Command",permalink:"/api/interfaces/Command",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Clipboard",permalink:"/api/interfaces/Clipboard"},next:{title:"Configuration",permalink:"/api/interfaces/Configuration"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"arguments?",id:"arguments",level:3},{value:"Source",id:"source",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-command",children:"Interface: Command"}),"\n",(0,s.jsx)(n.p,{children:"Represents a reference to a command. Provides a title which\nwill be used to represent a command in the UI and, optionally,\nan array of arguments which will be passed to the command handler\nfunction when invoked."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"arguments",children:"arguments?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"arguments"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L55",children:"packages/extension-api/src/extension-api.d.ts:55"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"command"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L52",children:"packages/extension-api/src/extension-api.d.ts:52"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L51",children:"packages/extension-api/src/extension-api.d.ts:51"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"tooltip"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L53",children:"packages/extension-api/src/extension-api.d.ts:53"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const i={},o=s.createContext(i);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67fccd64.79596fd0.js b/assets/js/67fccd64.760428c5.js similarity index 82% rename from assets/js/67fccd64.79596fd0.js rename to assets/js/67fccd64.760428c5.js index 482d049cb54..ccc73402e65 100644 --- a/assets/js/67fccd64.79596fd0.js +++ b/assets/js/67fccd64.760428c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{37186:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=n(24246),i=n(71670);const r={},c="Interface: ContainerStatsInfo",a={id:"interfaces/ContainerStatsInfo",title:"Interface: ContainerStatsInfo",description:"Properties",source:"@site/api/interfaces/ContainerStatsInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"},next:{title:"CustomPick",permalink:"/api/interfaces/CustomPick"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Source",id:"source",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Source",id:"source-4",level:4},{value:"networks",id:"networks",level:3},{value:"Source",id:"source-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Source",id:"source-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Source",id:"source-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Source",id:"source-8",level:4},{value:"preread",id:"preread",level:3},{value:"Source",id:"source-9",level:4},{value:"read",id:"read",level:3},{value:"Source",id:"source-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"blkio_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/BlkioStats",children:(0,t.jsx)(s.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2912",children:"packages/extension-api/src/extension-api.d.ts:2912"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"cpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2917",children:"packages/extension-api/src/extension-api.d.ts:2917"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineId"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2907",children:"packages/extension-api/src/extension-api.d.ts:2907"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"enginename",children:"engineName"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineName"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2908",children:"packages/extension-api/src/extension-api.d.ts:2908"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"memory_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/MemoryStats",children:(0,t.jsx)(s.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2916",children:"packages/extension-api/src/extension-api.d.ts:2916"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"networks",children:"networks"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"networks"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/NetworkStats",children:(0,t.jsx)(s.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2915",children:"packages/extension-api/src/extension-api.d.ts:2915"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"num_procs"}),": ",(0,t.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2913",children:"packages/extension-api/src/extension-api.d.ts:2913"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"pids_stats",children:"pids_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"pids_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/PidsStats",children:(0,t.jsx)(s.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"precpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2918",children:"packages/extension-api/src/extension-api.d.ts:2918"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"preread",children:"preread"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"preread"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2910",children:"packages/extension-api/src/extension-api.d.ts:2910"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"read",children:"read"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"read"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2909",children:"packages/extension-api/src/extension-api.d.ts:2909"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"storage_stats",children:"storage_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"storage_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/StorageStats",children:(0,t.jsx)(s.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2914",children:"packages/extension-api/src/extension-api.d.ts:2914"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>c});var t=n(27378);const i={},r=t.createContext(i);function c(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{37186:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=n(24246),i=n(71670);const r={},c="Interface: ContainerStatsInfo",o={id:"interfaces/ContainerStatsInfo",title:"Interface: ContainerStatsInfo",description:"Properties",source:"@site/api/interfaces/ContainerStatsInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"},next:{title:"CustomPick",permalink:"/api/interfaces/CustomPick"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"blkio_stats?",id:"blkio_stats",level:3},{value:"Source",id:"source",level:4},{value:"cpu_stats",id:"cpu_stats",level:3},{value:"Source",id:"source-1",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-2",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-3",level:4},{value:"memory_stats",id:"memory_stats",level:3},{value:"Source",id:"source-4",level:4},{value:"networks",id:"networks",level:3},{value:"Source",id:"source-5",level:4},{value:"num_procs",id:"num_procs",level:3},{value:"Source",id:"source-6",level:4},{value:"pids_stats?",id:"pids_stats",level:3},{value:"Source",id:"source-7",level:4},{value:"precpu_stats",id:"precpu_stats",level:3},{value:"Source",id:"source-8",level:4},{value:"preread",id:"preread",level:3},{value:"Source",id:"source-9",level:4},{value:"read",id:"read",level:3},{value:"Source",id:"source-10",level:4},{value:"storage_stats?",id:"storage_stats",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"blkio_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/BlkioStats",children:(0,t.jsx)(s.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2912",children:"packages/extension-api/src/extension-api.d.ts:2912"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"cpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2917",children:"packages/extension-api/src/extension-api.d.ts:2917"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"engineid",children:"engineId"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineId"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2907",children:"packages/extension-api/src/extension-api.d.ts:2907"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"enginename",children:"engineName"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"engineName"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2908",children:"packages/extension-api/src/extension-api.d.ts:2908"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"memory_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/MemoryStats",children:(0,t.jsx)(s.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2916",children:"packages/extension-api/src/extension-api.d.ts:2916"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"networks",children:"networks"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"networks"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/NetworkStats",children:(0,t.jsx)(s.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2915",children:"packages/extension-api/src/extension-api.d.ts:2915"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"num_procs"}),": ",(0,t.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2913",children:"packages/extension-api/src/extension-api.d.ts:2913"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"pids_stats",children:"pids_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"pids_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/PidsStats",children:(0,t.jsx)(s.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2911",children:"packages/extension-api/src/extension-api.d.ts:2911"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"precpu_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,t.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2918",children:"packages/extension-api/src/extension-api.d.ts:2918"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"preread",children:"preread"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"preread"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2910",children:"packages/extension-api/src/extension-api.d.ts:2910"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"read",children:"read"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"read"}),": ",(0,t.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2909",children:"packages/extension-api/src/extension-api.d.ts:2909"})}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"storage_stats",children:"storage_stats?"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"optional"})," ",(0,t.jsx)(s.strong,{children:"storage_stats"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/StorageStats",children:(0,t.jsx)(s.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2914",children:"packages/extension-api/src/extension-api.d.ts:2914"})})]})}function h(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var t=n(27378);const i={},r=t.createContext(i);function c(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/688ee267.4453f4ff.js b/assets/js/688ee267.3e358e5d.js similarity index 98% rename from assets/js/688ee267.4453f4ff.js rename to assets/js/688ee267.3e358e5d.js index 8877e7b0940..65c4d3a375c 100644 --- a/assets/js/688ee267.4453f4ff.js +++ b/assets/js/688ee267.3e358e5d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{44466:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getSession",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchangesessions",children:"Function: onDidChangeSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeSessions"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when the authentication sessions of an authentication provider have\nbeen added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3675",children:"packages/extension-api/src/extension-api.d.ts:3675"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var i=s(27378);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{44466:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChangeSessions()",c={id:"namespaces/authentication/functions/onDidChangeSessions",title:"Function: onDidChangeSessions()",description:"onDidChangeSessions(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getSession",permalink:"/api/namespaces/authentication/functions/getSession"},next:{title:"registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchangesessions",children:"Function: onDidChangeSessions()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChangeSessions"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["An ",(0,i.jsx)(n.a,{href:"#Event",children:"event"})," which fires when the authentication sessions of an authentication provider have\nbeen added, removed, or changed."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3675",children:"packages/extension-api/src/extension-api.d.ts:3675"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var i=s(27378);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6a1fe514.96fbf35d.js b/assets/js/6a1fe514.f4ab80e3.js similarity index 75% rename from assets/js/6a1fe514.96fbf35d.js rename to assets/js/6a1fe514.f4ab80e3.js index c28a5d7f563..c2ddfe4e60c 100644 --- a/assets/js/6a1fe514.96fbf35d.js +++ b/assets/js/6a1fe514.f4ab80e3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{15369:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=r(24246),i=r(71670);const t={},o="Interface: RegistrySuggestedProvider",c={id:"interfaces/RegistrySuggestedProvider",title:"Interface: RegistrySuggestedProvider",description:"Properties",source:"@site/api/interfaces/RegistrySuggestedProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryProvider",permalink:"/api/interfaces/RegistryProvider"},next:{title:"RunError",permalink:"/api/interfaces/RunError"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L625",children:"packages/extension-api/src/extension-api.d.ts:625"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L626",children:"packages/extension-api/src/extension-api.d.ts:626"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var s=r(27378);const i={},t=s.createContext(i);function o(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{15369:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>u,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=r(24246),i=r(71670);const t={},c="Interface: RegistrySuggestedProvider",o={id:"interfaces/RegistrySuggestedProvider",title:"Interface: RegistrySuggestedProvider",description:"Properties",source:"@site/api/interfaces/RegistrySuggestedProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryProvider",permalink:"/api/interfaces/RegistryProvider"},next:{title:"RunError",permalink:"/api/interfaces/RunError"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-registrysuggestedprovider",children:"Interface: RegistrySuggestedProvider"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"icon"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"name"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L625",children:"packages/extension-api/src/extension-api.d.ts:625"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L626",children:"packages/extension-api/src/extension-api.d.ts:626"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6aa0b043.8ada3374.js b/assets/js/6aa0b043.7ef8ca39.js similarity index 95% rename from assets/js/6aa0b043.8ada3374.js rename to assets/js/6aa0b043.7ef8ca39.js index add64e7551f..8c1d3e7482c 100644 --- a/assets/js/6aa0b043.8ada3374.js +++ b/assets/js/6aa0b043.7ef8ca39.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{22525:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var o=r(24246),i=r(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"connection"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"providerId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L577",children:"packages/extension-api/src/extension-api.d.ts:577"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var o=r(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{22525:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var o=r(24246),i=r(71670);const t={},c="Interface: ProviderContainerConnection",s={id:"interfaces/ProviderContainerConnection",title:"Interface: ProviderContainerConnection",description:"Properties",source:"@site/api/interfaces/ProviderContainerConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle"},next:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-providercontainerconnection",children:"Interface: ProviderContainerConnection"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"connection"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"providerId"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L577",children:"packages/extension-api/src/extension-api.d.ts:577"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>s,a:()=>c});var o=r(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e30ac7b.7f88e4fd.js b/assets/js/6e30ac7b.b62145c6.js similarity index 87% rename from assets/js/6e30ac7b.7f88e4fd.js rename to assets/js/6e30ac7b.b62145c6.js index 25a09288b82..38e78e1ce12 100644 --- a/assets/js/6e30ac7b.7f88e4fd.js +++ b/assets/js/6e30ac7b.b62145c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{53670:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var c=i(24246),s=i(71670);const t={},o="Interface: QuickPickOptions",r={id:"interfaces/QuickPickOptions",title:"Interface: QuickPickOptions",description:"Options to configure the behavior of the quick pick UI.",source:"@site/api/interfaces/QuickPickOptions.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"},next:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Source",id:"source",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Source",id:"source-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-5",level:4},{value:"Methods",id:"methods",level:2},{value:"onDidSelectItem()?",id:"ondidselectitem",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-6",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"}),"\n",(0,c.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"canPickMany"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to make the picker accept multiple selections, if true the result is an array of picks."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1006",children:"packages/extension-api/src/extension-api.d.ts:1006"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Set to ",(0,c.jsx)(n.code,{children:"true"})," to keep the picker open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1001",children:"packages/extension-api/src/extension-api.d.ts:1001"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"matchOnDescription"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L985",children:"packages/extension-api/src/extension-api.d.ts:985"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"matchOnDetail"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L990",children:"packages/extension-api/src/extension-api.d.ts:990"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"placeHolder"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to pick on."}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"title"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string that represents the title of the quick pick."}),"\n",(0,c.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L980",children:"packages/extension-api/src/extension-api.d.ts:980"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"onDidSelectItem"}),"(",(0,c.jsx)(n.code,{children:"item"}),"): ",(0,c.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,c.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"item"}),": ",(0,c.jsx)(n.code,{children:"string"})," | ",(0,c.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,c.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"any"})}),"\n",(0,c.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1012",children:"packages/extension-api/src/extension-api.d.ts:1012"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var c=i(27378);const s={},t=c.createContext(s);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{53670:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var c=i(24246),s=i(71670);const t={},o="Interface: QuickPickOptions",r={id:"interfaces/QuickPickOptions",title:"Interface: QuickPickOptions",description:"Options to configure the behavior of the quick pick UI.",source:"@site/api/interfaces/QuickPickOptions.md",sourceDirName:"interfaces",slug:"/interfaces/QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickItem",permalink:"/api/interfaces/QuickPickItem"},next:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"canPickMany?",id:"canpickmany",level:3},{value:"Source",id:"source",level:4},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source-1",level:4},{value:"matchOnDescription?",id:"matchondescription",level:3},{value:"Source",id:"source-2",level:4},{value:"matchOnDetail?",id:"matchondetail",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-5",level:4},{value:"Methods",id:"methods",level:2},{value:"onDidSelectItem()?",id:"ondidselectitem",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"}),"\n",(0,c.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"canPickMany"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to make the picker accept multiple selections, if true the result is an array of picks."}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1006",children:"packages/extension-api/src/extension-api.d.ts:1006"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Set to ",(0,c.jsx)(n.code,{children:"true"})," to keep the picker open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1001",children:"packages/extension-api/src/extension-api.d.ts:1001"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"matchOnDescription"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L985",children:"packages/extension-api/src/extension-api.d.ts:985"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"matchOnDetail"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L990",children:"packages/extension-api/src/extension-api.d.ts:990"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"placeHolder"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to pick on."}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L995",children:"packages/extension-api/src/extension-api.d.ts:995"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"title"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional string that represents the title of the quick pick."}),"\n",(0,c.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L980",children:"packages/extension-api/src/extension-api.d.ts:980"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"onDidSelectItem"}),"(",(0,c.jsx)(n.code,{children:"item"}),"): ",(0,c.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,c.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"item"}),": ",(0,c.jsx)(n.code,{children:"string"})," | ",(0,c.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,c.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,c.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.code,{children:"any"})}),"\n",(0,c.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1012",children:"packages/extension-api/src/extension-api.d.ts:1012"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>o});var c=i(27378);const s={},t=c.createContext(s);function o(e){const n=c.useContext(t);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e92edd9.f4bb86c2.js b/assets/js/6e92edd9.b367cc5c.js similarity index 89% rename from assets/js/6e92edd9.f4bb86c2.js rename to assets/js/6e92edd9.b367cc5c.js index 97bbe8a5879..668efb876c6 100644 --- a/assets/js/6e92edd9.f4bb86c2.js +++ b/assets/js/6e92edd9.b367cc5c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{61422:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>o});var r=s(24246),i=s(71670);const d={},t="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Command",permalink:"/api/interfaces/Command"},next:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},a={},o=[{value:"Indexable",id:"indexable",level:2},{value:"Methods",id:"methods",level:2},{value:"get()",id:"get",level:3},{value:"get(section)",id:"getsection",level:4},{value:"Type parameters",id:"type-parameters",level:5},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Source",id:"source",level:5},{value:"get(section, defaultValue)",id:"getsection-defaultvalue",level:4},{value:"Type parameters",id:"type-parameters-1",level:5},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"}),"\n",(0,r.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,r.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\n",(0,r.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"defaultValue"}),"): ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"defaultValue"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,r.jsx)(n.h5,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"has"}),"(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L726",children:"packages/extension-api/src/extension-api.d.ts:726"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"update"}),"(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"value"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Update a configuration value. The updated configuration values are persisted."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"value"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L732",children:"packages/extension-api/src/extension-api.d.ts:732"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var r=s(27378);const i={},d=r.createContext(i);function t(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{61422:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=s(24246),i=s(71670);const t={},d="Interface: Configuration",c={id:"interfaces/Configuration",title:"Interface: Configuration",description:"Indexable",source:"@site/api/interfaces/Configuration.md",sourceDirName:"interfaces",slug:"/interfaces/Configuration",permalink:"/api/interfaces/Configuration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Command",permalink:"/api/interfaces/Command"},next:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"}},o={},a=[{value:"Indexable",id:"indexable",level:2},{value:"Methods",id:"methods",level:2},{value:"get()",id:"get",level:3},{value:"get(section)",id:"getsection",level:4},{value:"Type parameters",id:"type-parameters",level:5},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Source",id:"source",level:5},{value:"get(section, defaultValue)",id:"getsection-defaultvalue",level:4},{value:"Type parameters",id:"type-parameters-1",level:5},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-1",level:5},{value:"has()",id:"has",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-configuration",children:"Interface: Configuration"}),"\n",(0,r.jsx)(n.h2,{id:"indexable",children:"Indexable"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"get",children:"get()"}),"\n",(0,r.jsx)(n.h4,{id:"getsection",children:"get(section)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\n",(0,r.jsx)(n.h4,{id:"getsection-defaultvalue",children:"get(section, defaultValue)"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"get"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"defaultValue"}),"): ",(0,r.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Return a value from this configuration."}),"\n",(0,r.jsx)(n.h5,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"T"})]}),"\n",(0,r.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"defaultValue"}),": ",(0,r.jsx)(n.code,{children:"T"})]}),"\n",(0,r.jsxs)(n.p,{children:["A value should be returned when no value could be found, is ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsxs)(n.p,{children:["The value ",(0,r.jsx)(n.code,{children:"section"})," denotes or the default."]}),"\n",(0,r.jsx)(n.h5,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"has",children:"has()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"has"}),"(",(0,r.jsx)(n.code,{children:"section"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Check if this configuration has a certain value."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["Configuration name, supports ",(0,r.jsx)(n.em,{children:"dotted"})," names."]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"true"})," if the section doesn't resolve to ",(0,r.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L726",children:"packages/extension-api/src/extension-api.d.ts:726"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"update"}),"(",(0,r.jsx)(n.code,{children:"section"}),", ",(0,r.jsx)(n.code,{children:"value"}),"): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Update a configuration value. The updated configuration values are persisted."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"section"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"value"}),": ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L732",children:"packages/extension-api/src/extension-api.d.ts:732"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>d});var r=s(27378);const i={},t=r.createContext(i);function d(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6eafe0c7.c4115619.js b/assets/js/6eafe0c7.0842f474.js similarity index 86% rename from assets/js/6eafe0c7.c4115619.js rename to assets/js/6eafe0c7.0842f474.js index 618732575bf..8ec9e2fc549 100644 --- a/assets/js/6eafe0c7.c4115619.js +++ b/assets/js/6eafe0c7.0842f474.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{80468:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const d={},c="Interface: EndpointSettings",o={id:"interfaces/EndpointSettings",title:"Interface: EndpointSettings",description:"Properties",source:"@site/api/interfaces/EndpointSettings.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointSettings",permalink:"/api/interfaces/EndpointSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"},next:{title:"Event",permalink:"/api/interfaces/Event"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Source",id:"source-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Source",id:"source-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Source",id:"source-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Source",id:"source-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Source",id:"source-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Source",id:"source-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Source",id:"source-10",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Source",id:"source-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2515",children:"packages/extension-api/src/extension-api.d.ts:2515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DNSNames"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List of all DNS names an endpoint has on a specific network. This list is based on the container name, network\naliases, container short ID, and hostname."}),"\n",(0,i.jsxs)(n.p,{children:["These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by\nappending ",(0,i.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,i.jsx)(n.code,{children:"testnet"}),", ",(0,i.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,i.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2570",children:"packages/extension-api/src/extension-api.d.ts:2570"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DriverOpts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2560",children:"packages/extension-api/src/extension-api.d.ts:2560"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2525",children:"packages/extension-api/src/extension-api.d.ts:2525"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2530",children:"packages/extension-api/src/extension-api.d.ts:2530"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2555",children:"packages/extension-api/src/extension-api.d.ts:2555"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,i.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2506",children:"packages/extension-api/src/extension-api.d.ts:2506"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2540",children:"packages/extension-api/src/extension-api.d.ts:2540"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2508",children:"packages/extension-api/src/extension-api.d.ts:2508"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2513",children:"packages/extension-api/src/extension-api.d.ts:2513"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2520",children:"packages/extension-api/src/extension-api.d.ts:2520"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},d=i.createContext(r);function c(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{80468:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const c={},d="Interface: EndpointSettings",o={id:"interfaces/EndpointSettings",title:"Interface: EndpointSettings",description:"Properties",source:"@site/api/interfaces/EndpointSettings.md",sourceDirName:"interfaces",slug:"/interfaces/EndpointSettings",permalink:"/api/interfaces/EndpointSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EndpointIPAMConfig",permalink:"/api/interfaces/EndpointIPAMConfig"},next:{title:"Event",permalink:"/api/interfaces/Event"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Aliases?",id:"aliases",level:3},{value:"Source",id:"source",level:4},{value:"DNSNames?",id:"dnsnames",level:3},{value:"Source",id:"source-1",level:4},{value:"DriverOpts?",id:"driveropts",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"EndpointID?",id:"endpointid",level:3},{value:"Source",id:"source-3",level:4},{value:"Gateway?",id:"gateway",level:3},{value:"Source",id:"source-4",level:4},{value:"GlobalIPv6Address?",id:"globalipv6address",level:3},{value:"Source",id:"source-5",level:4},{value:"GlobalIPv6PrefixLen?",id:"globalipv6prefixlen",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAMConfig?",id:"ipamconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"IPAddress?",id:"ipaddress",level:3},{value:"Source",id:"source-8",level:4},{value:"IPPrefixLen?",id:"ipprefixlen",level:3},{value:"Source",id:"source-9",level:4},{value:"IPv6Gateway?",id:"ipv6gateway",level:3},{value:"Source",id:"source-10",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-11",level:4},{value:"MacAddress?",id:"macaddress",level:3},{value:"Source",id:"source-12",level:4},{value:"NetworkID?",id:"networkid",level:3},{value:"Source",id:"source-13",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-endpointsettings",children:"Interface: EndpointSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Aliases"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2515",children:"packages/extension-api/src/extension-api.d.ts:2515"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsnames",children:"DNSNames?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DNSNames"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List of all DNS names an endpoint has on a specific network. This list is based on the container name, network\naliases, container short ID, and hostname."}),"\n",(0,i.jsxs)(n.p,{children:["These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by\nappending ",(0,i.jsx)(n.code,{children:"."}),". For instance, if container name is ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the network is named\n",(0,i.jsx)(n.code,{children:"testnet"}),", ",(0,i.jsx)(n.code,{children:"DNSNames"})," will contain ",(0,i.jsx)(n.code,{children:"my.ctr"})," and the FQDN will be ",(0,i.jsx)(n.code,{children:"my.ctr.testnet"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2570",children:"packages/extension-api/src/extension-api.d.ts:2570"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driveropts",children:"DriverOpts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DriverOpts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2560",children:"packages/extension-api/src/extension-api.d.ts:2560"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"endpointid",children:"EndpointID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID for the service endpoint in a Sandbox."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2525",children:"packages/extension-api/src/extension-api.d.ts:2525"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"gateway",children:"Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Gateway address for this network."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2530",children:"packages/extension-api/src/extension-api.d.ts:2530"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the global IPv6 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2555",children:"packages/extension-api/src/extension-api.d.ts:2555"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAMConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/EndpointIPAMConfig",children:(0,i.jsx)(n.code,{children:"EndpointIPAMConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"EndpointIPAMConfig represents an endpoint's IPAM configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2506",children:"packages/extension-api/src/extension-api.d.ts:2506"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipaddress",children:"IPAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2535",children:"packages/extension-api/src/extension-api.d.ts:2535"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Mask length of the IPv4 address."}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2540",children:"packages/extension-api/src/extension-api.d.ts:2540"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"IPv6 gateway address."}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2545",children:"packages/extension-api/src/extension-api.d.ts:2545"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2508",children:"packages/extension-api/src/extension-api.d.ts:2508"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"macaddress",children:"MacAddress?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"MAC address for the endpoint on this network. The network driver might ignore this parameter."}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2513",children:"packages/extension-api/src/extension-api.d.ts:2513"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkid",children:"NetworkID?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Unique ID of the network."}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2520",children:"packages/extension-api/src/extension-api.d.ts:2520"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var i=s(27378);const r={},c=i.createContext(r);function d(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70e3b13c.7fe14c43.js b/assets/js/70e3b13c.1bb1b752.js similarity index 95% rename from assets/js/70e3b13c.7fe14c43.js rename to assets/js/70e3b13c.1bb1b752.js index aebed57a1d3..eb128fb732d 100644 --- a/assets/js/70e3b13c.7fe14c43.js +++ b/assets/js/70e3b13c.1bb1b752.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{12308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),n=r(71670);const i={},c="Function: registerRegistry()",o={id:"namespaces/registry/functions/registerRegistry",title:"Function: registerRegistry()",description:"registerRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"},next:{title:"registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,t.jsx)(s.code,{children:"registry"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"registry"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L660",children:"packages/extension-api/src/extension-api.d.ts:660"})})]})}function p(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var t=r(27378);const n={},i=t.createContext(n);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{12308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),n=r(71670);const i={},c="Function: registerRegistry()",o={id:"namespaces/registry/functions/registerRegistry",title:"Function: registerRegistry()",description:"registerRegistry(registry): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"},next:{title:"registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"function-registerregistry",children:"Function: registerRegistry()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"registerRegistry"}),"(",(0,t.jsx)(s.code,{children:"registry"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"registry"}),": ",(0,t.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,t.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,t.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L660",children:"packages/extension-api/src/extension-api.d.ts:660"})})]})}function p(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var t=r(27378);const n={},i=t.createContext(n);function c(e){const s=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/714e70d1.37eb94ea.js b/assets/js/714e70d1.1260bd22.js similarity index 91% rename from assets/js/714e70d1.37eb94ea.js rename to assets/js/714e70d1.1260bd22.js index 601a40e037d..ad12cecbbfe 100644 --- a/assets/js/714e70d1.37eb94ea.js +++ b/assets/js/714e70d1.1260bd22.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{33330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: ProviderEvent",o={id:"interfaces/ProviderEvent",title:"Interface: ProviderEvent",description:"Properties",source:"@site/api/interfaces/ProviderEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderEvent",permalink:"/api/interfaces/ProviderEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"},next:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"status"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,t.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{33330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var t=r(24246),s=r(71670);const i={},c="Interface: ProviderEvent",o={id:"interfaces/ProviderEvent",title:"Interface: ProviderEvent",description:"Properties",source:"@site/api/interfaces/ProviderEvent.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderEvent",permalink:"/api/interfaces/ProviderEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderDetectionCheck",permalink:"/api/interfaces/ProviderDetectionCheck"},next:{title:"ProviderImages",permalink:"/api/interfaces/ProviderImages"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providerevent",children:"Interface: ProviderEvent"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L546",children:"packages/extension-api/src/extension-api.d.ts:546"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L547",children:"packages/extension-api/src/extension-api.d.ts:547"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"status"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,t.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L548",children:"packages/extension-api/src/extension-api.d.ts:548"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const s={},i=t.createContext(s);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/71748509.d2b3ed6c.js b/assets/js/71748509.26b7b045.js similarity index 95% rename from assets/js/71748509.d2b3ed6c.js rename to assets/js/71748509.26b7b045.js index 58f0bdf2456..676ce60599b 100644 --- a/assets/js/71748509.d2b3ed6c.js +++ b/assets/js/71748509.26b7b045.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{84530:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var n=r(24246),t=r(71670);const i={},c="Function: unregisterRegistry()",o={id:"namespaces/registry/functions/unregisterRegistry",title:"Function: unregisterRegistry()",description:"unregisterRegistry(registry): void",source:"@site/api/namespaces/registry/functions/unregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"unregisterRegistry"}),"(",(0,n.jsx)(s.code,{children:"registry"}),"): ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"registry"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L663",children:"packages/extension-api/src/extension-api.d.ts:663"})})]})}function l(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var n=r(27378);const t={},i=n.createContext(t);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{84530:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var n=r(24246),t=r(71670);const i={},c="Function: unregisterRegistry()",o={id:"namespaces/registry/functions/unregisterRegistry",title:"Function: unregisterRegistry()",description:"unregisterRegistry(registry): void",source:"@site/api/namespaces/registry/functions/unregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/unregisterRegistry",permalink:"/api/namespaces/registry/functions/unregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"},next:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"function-unregisterregistry",children:"Function: unregisterRegistry()"}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.strong,{children:"unregisterRegistry"}),"(",(0,n.jsx)(s.code,{children:"registry"}),"): ",(0,n.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(s.p,{children:["\u2022 ",(0,n.jsx)(s.strong,{children:"registry"}),": ",(0,n.jsx)(s.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(s.code,{children:"Registry"})})]}),"\n",(0,n.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"void"})}),"\n",(0,n.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L663",children:"packages/extension-api/src/extension-api.d.ts:663"})})]})}function l(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>o,a:()=>c});var n=r(27378);const t={},i=n.createContext(t);function c(e){const s=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7258860f.95120d47.js b/assets/js/7258860f.95120d47.js new file mode 100644 index 00000000000..ed1df4c3e75 --- /dev/null +++ b/assets/js/7258860f.95120d47.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{79993:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: logsContainer()",c={id:"namespaces/containerEngine/functions/logsContainer",title:"Function: logsContainer()",description:"logsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/logsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes"},next:{title:"onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"logsContainer"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"id"}),", ",(0,i.jsx)(n.code,{children:"callback"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get the streamed logs of a container"}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(n.code,{children:"name"})," can be either ",(0,i.jsx)(n.code,{children:"data"})," (and ",(0,i.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3235",children:"packages/extension-api/src/extension-api.d.ts:3235"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7258860f.ad4a1342.js b/assets/js/7258860f.ad4a1342.js deleted file mode 100644 index 3d0122a574b..00000000000 --- a/assets/js/7258860f.ad4a1342.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{79993:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: logsContainer()",c={id:"namespaces/containerEngine/functions/logsContainer",title:"Function: logsContainer()",description:"logsContainer(engineId, id, callback): Promise\\",source:"@site/api/namespaces/containerEngine/functions/logsContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes"},next:{title:"onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-logscontainer",children:"Function: logsContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"logsContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),", ",(0,i.jsx)(e.code,{children:"callback"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Get the streamed logs of a container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(e.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(e.code,{children:"name"})," can be either ",(0,i.jsx)(e.code,{children:"data"})," (and ",(0,i.jsx)(e.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(e.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(e.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3235",children:"packages/extension-api/src/extension-api.d.ts:3235"})})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/73f18a6f.b28f62b0.js b/assets/js/73f18a6f.ed8ddb43.js similarity index 95% rename from assets/js/73f18a6f.b28f62b0.js rename to assets/js/73f18a6f.ed8ddb43.js index d7d558db01a..b2bea227c1b 100644 --- a/assets/js/73f18a6f.b28f62b0.js +++ b/assets/js/73f18a6f.ed8ddb43.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{93268:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=n(24246),i=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"},next:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"createProvider"}),"(",(0,t.jsx)(r.code,{children:"provider"}),"): ",(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"provider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,t.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L582",children:"packages/extension-api/src/extension-api.d.ts:582"})})]})}function l(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var t=n(27378);const i={},o=t.createContext(i);function s(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{93268:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=n(24246),i=n(71670);const o={},s="Function: createProvider()",c={id:"namespaces/provider/functions/createProvider",title:"Function: createProvider()",description:"createProvider(provider): Provider",source:"@site/api/namespaces/provider/functions/createProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/createProvider",permalink:"/api/namespaces/provider/functions/createProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: provider",permalink:"/api/namespaces/provider/"},next:{title:"getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-createprovider",children:"Function: createProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"createProvider"}),"(",(0,t.jsx)(r.code,{children:"provider"}),"): ",(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"provider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/ProviderOptions",children:(0,t.jsx)(r.code,{children:"ProviderOptions"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/interfaces/Provider",children:(0,t.jsx)(r.code,{children:"Provider"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L582",children:"packages/extension-api/src/extension-api.d.ts:582"})})]})}function l(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>s});var t=n(27378);const i={},o=t.createContext(i);function s(e){const r=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73f9658e.7f87fc6c.js b/assets/js/73f9658e.06ed5082.js similarity index 98% rename from assets/js/73f9658e.7f87fc6c.js rename to assets/js/73f9658e.06ed5082.js index d8cb055eff0..2a7e85ecee0 100644 --- a/assets/js/73f9658e.7f87fc6c.js +++ b/assets/js/73f9658e.06ed5082.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{40680:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const a={},r="Function: pushImage()",c={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"imageId"}),", ",(0,i.jsx)(n.code,{children:"callback"}),", ",(0,i.jsx)(n.code,{children:"authInfo"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,i.jsxs)(n.p,{children:["If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, ",(0,i.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"imageId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(n.code,{children:"name"})," can be either ",(0,i.jsx)(n.code,{children:"data"}),"(and ",(0,i.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"authInfo?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,i.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,i.jsx)(n.p,{children:"Authentication credentials"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3344",children:"packages/extension-api/src/extension-api.d.ts:3344"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{40680:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const a={},r="Function: pushImage()",c={id:"namespaces/containerEngine/functions/pushImage",title:"Function: pushImage()",description:"pushImage(engineId, imageId, callback, authInfo?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/pushImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"},next:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-pushimage",children:"Function: pushImage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"pushImage"}),"(",(0,i.jsx)(n.code,{children:"engineId"}),", ",(0,i.jsx)(n.code,{children:"imageId"}),", ",(0,i.jsx)(n.code,{children:"callback"}),", ",(0,i.jsx)(n.code,{children:"authInfo"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Push an image to a registry."}),"\n",(0,i.jsxs)(n.p,{children:["If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, ",(0,i.jsx)(n.code,{children:"registry.example.com/myimage:latest"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"imageId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"callback"})]}),"\n",(0,i.jsxs)(n.p,{children:["the function called when new logs are emitted or new events happen on the stream. The value of ",(0,i.jsx)(n.code,{children:"name"})," can be either ",(0,i.jsx)(n.code,{children:"data"}),"(and ",(0,i.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,i.jsx)(n.code,{children:"end"})," indicating the end of the stream, or ",(0,i.jsx)(n.code,{children:"first-message"})," indicating no data has been emitted yet on the stream."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"authInfo?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerAuthInfo",children:(0,i.jsx)(n.code,{children:"ContainerAuthInfo"})})]}),"\n",(0,i.jsx)(n.p,{children:"Authentication credentials"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3344",children:"packages/extension-api/src/extension-api.d.ts:3344"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/74b658de.a8a09072.js b/assets/js/74b658de.12a2861b.js similarity index 97% rename from assets/js/74b658de.a8a09072.js rename to assets/js/74b658de.12a2861b.js index fe529aaba83..5fe5181cd9a 100644 --- a/assets/js/74b658de.a8a09072.js +++ b/assets/js/74b658de.12a2861b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{59451:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=o(24246),r=o(71670);const t={},i="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removePod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>i});var s=o(27378);const r={},t=s.createContext(r);function i(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{59451:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var s=o(24246),r=o(71670);const t={},i="Function: removePod()",c={id:"namespaces/containerEngine/functions/removePod",title:"Function: removePod()",description:"removePod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/removePod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/removePod",permalink:"/api/namespaces/containerEngine/functions/removePod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"pushImage",permalink:"/api/namespaces/containerEngine/functions/pushImage"},next:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-removepod",children:"Function: removePod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"removePod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3422",children:"packages/extension-api/src/extension-api.d.ts:3422"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>i});var s=o(27378);const r={},t=s.createContext(r);function i(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7500e360.f7d344ee.js b/assets/js/7500e360.262be0d8.js similarity index 78% rename from assets/js/7500e360.f7d344ee.js rename to assets/js/7500e360.262be0d8.js index 6e1506724a2..2ba7f751a64 100644 --- a/assets/js/7500e360.f7d344ee.js +++ b/assets/js/7500e360.262be0d8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{22147:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var o=s(24246),i=s(71670);const t={},a="Function: showSaveDialog()",c={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise \\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/SaveDialogOptions",children:(0,o.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1760",children:"packages/extension-api/src/extension-api.d.ts:1760"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var o=s(27378);const i={},t=o.createContext(i);function a(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{22147:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showSaveDialog()",r={id:"namespaces/window/functions/showSaveDialog",title:"Function: showSaveDialog()",description:"showSaveDialog(options?): Promise \\",source:"@site/api/namespaces/window/functions/showSaveDialog.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showQuickPick",permalink:"/api/namespaces/window/functions/showQuickPick"},next:{title:"showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showsavedialog",children:"Function: showSaveDialog()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showSaveDialog"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Shows a file save dialog to the user which allows to select a file\nfor saving-purposes."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/SaveDialogOptions",children:(0,o.jsx)(n.code,{children:"SaveDialogOptions"})})]}),"\n",(0,o.jsx)(n.p,{children:"Options that control the dialog."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected resource or ",(0,o.jsx)(n.code,{children:"undefined"}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1760",children:"packages/extension-api/src/extension-api.d.ts:1760"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var o=s(27378);const i={},t=o.createContext(i);function c(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7547d3bb.056772f4.js b/assets/js/7547d3bb.60df8373.js similarity index 97% rename from assets/js/7547d3bb.056772f4.js rename to assets/js/7547d3bb.60df8373.js index dfbd0a2d145..e69c4c32587 100644 --- a/assets/js/7547d3bb.056772f4.js +++ b/assets/js/7547d3bb.60df8373.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{41528:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const i={},s="Interface: ProviderCleanup",c={id:"interfaces/ProviderCleanup",title:"Interface: ProviderCleanup",description:"Allow to clean some resources in case for example",source:"@site/api/interfaces/ProviderCleanup.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"},next:{title:"ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"getActions()",id:"getactions",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L440",children:"packages/extension-api/src/extension-api.d.ts:440"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{41528:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),o=r(71670);const i={},s="Interface: ProviderCleanup",c={id:"interfaces/ProviderCleanup",title:"Interface: ProviderCleanup",description:"Allow to clean some resources in case for example",source:"@site/api/interfaces/ProviderCleanup.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart"},next:{title:"ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction"}},a={},d=[{value:"Methods",id:"methods",level:2},{value:"getActions()",id:"getactions",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanup",children:"Interface: ProviderCleanup"}),"\n",(0,t.jsx)(n.p,{children:"Allow to clean some resources in case for example"}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"getactions",children:"getActions()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getActions"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupAction",children:(0,t.jsx)(n.code,{children:"ProviderCleanupAction"})}),"[]>"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L440",children:"packages/extension-api/src/extension-api.d.ts:440"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var t=r(27378);const o={},i=t.createContext(o);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/786fee93.01948478.js b/assets/js/786fee93.d2256763.js similarity index 94% rename from assets/js/786fee93.01948478.js rename to assets/js/786fee93.d2256763.js index df4bf33571f..242edbcd17d 100644 --- a/assets/js/786fee93.01948478.js +++ b/assets/js/786fee93.d2256763.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{79261:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const a={},r="Variable: isLinux",c={id:"namespaces/env/variables/isLinux",title:"Variable: isLinux",description:"const isLinux: boolean",source:"@site/api/namespaces/env/variables/isLinux.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isLinux",permalink:"/api/namespaces/env/variables/isLinux",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"clipboard",permalink:"/api/namespaces/env/variables/clipboard"},next:{title:"isMac",permalink:"/api/namespaces/env/variables/isMac"}},o={},l=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"const"})," ",(0,i.jsx)(n.strong,{children:"isLinux"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,i.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Linux.\nIf the value is false, it means the current system is not Linux."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3723",children:"packages/extension-api/src/extension-api.d.ts:3723"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{79261:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var i=s(24246),t=s(71670);const a={},r="Variable: isLinux",c={id:"namespaces/env/variables/isLinux",title:"Variable: isLinux",description:"const isLinux: boolean",source:"@site/api/namespaces/env/variables/isLinux.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isLinux",permalink:"/api/namespaces/env/variables/isLinux",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"clipboard",permalink:"/api/namespaces/env/variables/clipboard"},next:{title:"isMac",permalink:"/api/namespaces/env/variables/isMac"}},o={},l=[{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"variable-islinux",children:"Variable: isLinux"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"const"})," ",(0,i.jsx)(n.strong,{children:"isLinux"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Flag indicating whether we are running on a Linux operating system."}),"\n",(0,i.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is Linux.\nIf the value is false, it means the current system is not Linux."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3723",children:"packages/extension-api/src/extension-api.d.ts:3723"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},a=i.createContext(t);function r(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/79f18c88.4f88da56.js b/assets/js/79f18c88.5ef384e8.js similarity index 80% rename from assets/js/79f18c88.4f88da56.js rename to assets/js/79f18c88.5ef384e8.js index 081f1ca313f..812b520b778 100644 --- a/assets/js/79f18c88.4f88da56.js +++ b/assets/js/79f18c88.5ef384e8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{15169:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="Interface: ContainerAuthInfo",a={id:"interfaces/ContainerAuthInfo",title:"Interface: ContainerAuthInfo",description:"Authentication credentials, used when pushing an image to a registry",source:"@site/api/interfaces/ContainerAuthInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"},next:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"}),"\n",(0,r.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2416",children:"packages/extension-api/src/extension-api.d.ts:2416"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2414",children:"packages/extension-api/src/extension-api.d.ts:2414"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2415",children:"packages/extension-api/src/extension-api.d.ts:2415"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2413",children:"packages/extension-api/src/extension-api.d.ts:2413"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{15169:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=s(24246),t=s(71670);const i={},o="Interface: ContainerAuthInfo",c={id:"interfaces/ContainerAuthInfo",title:"Interface: ContainerAuthInfo",description:"Authentication credentials, used when pushing an image to a registry",source:"@site/api/interfaces/ContainerAuthInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerAuthInfo",permalink:"/api/interfaces/ContainerAuthInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ConfigurationChangeEvent",permalink:"/api/interfaces/ConfigurationChangeEvent"},next:{title:"ContainerCreateOptions",permalink:"/api/interfaces/ContainerCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerauthinfo",children:"Interface: ContainerAuthInfo"}),"\n",(0,r.jsx)(n.p,{children:"Authentication credentials, used when pushing an image to a registry"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2416",children:"packages/extension-api/src/extension-api.d.ts:2416"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2414",children:"packages/extension-api/src/extension-api.d.ts:2414"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2415",children:"packages/extension-api/src/extension-api.d.ts:2415"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2413",children:"packages/extension-api/src/extension-api.d.ts:2413"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const t={},i=r.createContext(t);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7aa856d6.15598666.js b/assets/js/7aa856d6.0ad974c1.js similarity index 93% rename from assets/js/7aa856d6.15598666.js rename to assets/js/7aa856d6.0ad974c1.js index f725a9a10a8..c5691991e51 100644 --- a/assets/js/7aa856d6.15598666.js +++ b/assets/js/7aa856d6.0ad974c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{97542:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Variable: version",a={id:"variables/version",title:"Variable: version",description:"const version: string",source:"@site/api/variables/version.md",sourceDirName:"variables",slug:"/variables/version",permalink:"/api/variables/version",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The version of Podman Desktop."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L42",children:"packages/extension-api/src/extension-api.d.ts:42"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{97542:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(24246),s=t(71670);const o={},i="Variable: version",a={id:"variables/version",title:"Variable: version",description:"const version: string",source:"@site/api/variables/version.md",sourceDirName:"variables",slug:"/variables/version",permalink:"/api/variables/version",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"variable-version",children:"Variable: version"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"const"})," ",(0,r.jsx)(n.strong,{children:"version"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The version of Podman Desktop."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L42",children:"packages/extension-api/src/extension-api.d.ts:42"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7bef3f04.6ae745be.js b/assets/js/7bef3f04.6c143225.js similarity index 98% rename from assets/js/7bef3f04.6ae745be.js rename to assets/js/7bef3f04.6c143225.js index 1aa31cf3854..c942bbee885 100644 --- a/assets/js/7bef3f04.6ae745be.js +++ b/assets/js/7bef3f04.6c143225.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24498],{45613:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidRegisterContainerConnection()",c={id:"namespaces/provider/functions/onDidRegisterContainerConnection",title:"Function: onDidRegisterContainerConnection()",description:"onDidRegisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidRegisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L587",children:"packages/extension-api/src/extension-api.d.ts:587"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24498],{45613:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidRegisterContainerConnection()",c={id:"namespaces/provider/functions/onDidRegisterContainerConnection",title:"Function: onDidRegisterContainerConnection()",description:"onDidRegisterContainerConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidRegisterContainerConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidRegisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidRegisterContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"},next:{title:"onDidUnregisterContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidregistercontainerconnection",children:"Function: onDidRegisterContainerConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidRegisterContainerConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L587",children:"packages/extension-api/src/extension-api.d.ts:587"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c7a772e.4e2ee602.js b/assets/js/7c7a772e.6b1f0215.js similarity index 83% rename from assets/js/7c7a772e.4e2ee602.js rename to assets/js/7c7a772e.6b1f0215.js index 5211ff83181..e84dcc30e5d 100644 --- a/assets/js/7c7a772e.4e2ee602.js +++ b/assets/js/7c7a772e.6b1f0215.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{50383:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},d="Interface: WebviewPanel",t={id:"interfaces/WebviewPanel",title:"Interface: WebviewPanel",description:"A panel that contains a webview.",source:"@site/api/interfaces/WebviewPanel.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanel",permalink:"/api/interfaces/WebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"},next:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Source",id:"source",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Source",id:"source-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-5",level:4},{value:"visible",id:"visible",level:3},{value:"Source",id:"source-6",level:4},{value:"webview",id:"webview",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"}),"\n",(0,i.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"active"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1511",children:"packages/extension-api/src/extension-api.d.ts:1511"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1490",children:"packages/extension-api/src/extension-api.d.ts:1490"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidChangeViewState"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",children:(0,i.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1521",children:"packages/extension-api/src/extension-api.d.ts:1521"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidDispose"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,i.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,i.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,i.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1531",children:"packages/extension-api/src/extension-api.d.ts:1531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1485",children:"packages/extension-api/src/extension-api.d.ts:1485"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1480",children:"packages/extension-api/src/extension-api.d.ts:1480"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1516",children:"packages/extension-api/src/extension-api.d.ts:1516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"webview",children:"webview"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webview"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1506",children:"packages/extension-api/src/extension-api.d.ts:1506"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["This closes the panel if it showing and disposes of the resources owned by the webview.\nWebview panels are also disposed when the user closes the webview panel. Both cases\nfire the ",(0,i.jsx)(n.code,{children:"onDispose"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1546",children:"packages/extension-api/src/extension-api.d.ts:1546"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"reveal"}),"(",(0,i.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["When ",(0,i.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1537",children:"packages/extension-api/src/extension-api.d.ts:1537"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>d});var i=s(27378);const c={},r=i.createContext(c);function d(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{50383:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},t="Interface: WebviewPanel",d={id:"interfaces/WebviewPanel",title:"Interface: WebviewPanel",description:"A panel that contains a webview.",source:"@site/api/interfaces/WebviewPanel.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanel",permalink:"/api/interfaces/WebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewOptions",permalink:"/api/interfaces/WebviewOptions"},next:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"active",id:"active",level:3},{value:"Source",id:"source",level:4},{value:"iconPath?",id:"iconpath",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeViewState",id:"ondidchangeviewstate",level:3},{value:"Source",id:"source-2",level:4},{value:"onDidDispose",id:"ondiddispose",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"viewType",id:"viewtype",level:3},{value:"Source",id:"source-5",level:4},{value:"visible",id:"visible",level:3},{value:"Source",id:"source-6",level:4},{value:"webview",id:"webview",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"reveal()",id:"reveal",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanel",children:"Interface: WebviewPanel"}),"\n",(0,i.jsx)(n.p,{children:"A panel that contains a webview."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"active",children:"active"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"active"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is active (focused by the user)."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1511",children:"packages/extension-api/src/extension-api.d.ts:1511"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconpath",children:"iconPath?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"iconPath"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon for the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1490",children:"packages/extension-api/src/extension-api.d.ts:1490"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidchangeviewstate",children:"onDidChangeViewState"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidChangeViewState"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",children:(0,i.jsx)(n.code,{children:"WebviewPanelOnDidChangeViewStateEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel's view state changes."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1521",children:"packages/extension-api/src/extension-api.d.ts:1521"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddispose",children:"onDidDispose"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidDispose"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Fired when the panel is disposed."}),"\n",(0,i.jsxs)(n.p,{children:["This may be because the user closed the panel or because ",(0,i.jsx)(n.code,{children:".dispose()"})," was\ncalled on it."]}),"\n",(0,i.jsx)(n.p,{children:"Trying to use the panel after it has been disposed throws an exception."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1531",children:"packages/extension-api/src/extension-api.d.ts:1531"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel shown in UI."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1485",children:"packages/extension-api/src/extension-api.d.ts:1485"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"viewtype",children:"viewType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1480",children:"packages/extension-api/src/extension-api.d.ts:1480"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"visible",children:"visible"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"visible"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Whether the panel is visible."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1516",children:"packages/extension-api/src/extension-api.d.ts:1516"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"webview",children:"webview"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webview"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/interfaces/Webview",children:(0,i.jsx)(n.code,{children:"Webview"})})," belonging to the panel."]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1506",children:"packages/extension-api/src/extension-api.d.ts:1506"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["This closes the panel if it showing and disposes of the resources owned by the webview.\nWebview panels are also disposed when the user closes the webview panel. Both cases\nfire the ",(0,i.jsx)(n.code,{children:"onDispose"})," event."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1546",children:"packages/extension-api/src/extension-api.d.ts:1546"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"reveal",children:"reveal()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"reveal"}),"(",(0,i.jsx)(n.code,{children:"preserveFocus"}),"?): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show the webview panel."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"preserveFocus?"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(n.p,{children:["When ",(0,i.jsx)(n.code,{children:"true"}),", the webview will not take focus."]}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1537",children:"packages/extension-api/src/extension-api.d.ts:1537"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var i=s(27378);const c={},r=i.createContext(c);function t(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:t(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7cde3c49.0c33e067.js b/assets/js/7cde3c49.46bd4b2d.js similarity index 94% rename from assets/js/7cde3c49.0c33e067.js rename to assets/js/7cde3c49.46bd4b2d.js index f42b3549a33..82abed598ba 100644 --- a/assets/js/7cde3c49.0c33e067.js +++ b/assets/js/7cde3c49.46bd4b2d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{92634:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(24246),r=t(71670);const i={},s="Interface: VolumeDeleteOptions",c={id:"interfaces/VolumeDeleteOptions",title:"Interface: VolumeDeleteOptions",description:"Properties",source:"@site/api/interfaces/VolumeDeleteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"},next:{title:"VolumeInfo",permalink:"/api/interfaces/VolumeInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3166",children:"packages/extension-api/src/extension-api.d.ts:3166"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{92634:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(24246),r=t(71670);const i={},s="Interface: VolumeDeleteOptions",c={id:"interfaces/VolumeDeleteOptions",title:"Interface: VolumeDeleteOptions",description:"Properties",source:"@site/api/interfaces/VolumeDeleteOptions.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeCreateResponseInfo",permalink:"/api/interfaces/VolumeCreateResponseInfo"},next:{title:"VolumeInfo",permalink:"/api/interfaces/VolumeInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-volumedeleteoptions",children:"Interface: VolumeDeleteOptions"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"provider"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,o.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3166",children:"packages/extension-api/src/extension-api.d.ts:3166"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var o=t(27378);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d9edfb8.06db59f6.js b/assets/js/7d9edfb8.c775a4ff.js similarity index 89% rename from assets/js/7d9edfb8.06db59f6.js rename to assets/js/7d9edfb8.c775a4ff.js index 00f6adff0d8..6b0fec598c0 100644 --- a/assets/js/7d9edfb8.06db59f6.js +++ b/assets/js/7d9edfb8.c775a4ff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{81245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>r,toc:()=>l});var i=s(24246),t=s(71670);const a={},o="Function: listImages()",r={id:"namespaces/containerEngine/functions/listImages",title:"Function: listImages()",description:"listImages(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listImages.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listImages",permalink:"/api/namespaces/containerEngine/functions/listImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listimages",children:"Function: listImages()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listImages"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List the container images. Only images from a final layer (no children) are returned."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ListImagesOptions",children:(0,i.jsx)(n.code,{children:"ListImagesOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"optional options for listing images"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise resolving to an array of images information. This method returns a subset of the available information for images. To get the complete description of a specific image, you can use the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/getImageInspect",children:"containerEngine.getImageInspect"})," method."]}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 1: List all container images when no specific provider is provided.\nconst images = await listImages();\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3322",children:"packages/extension-api/src/extension-api.d.ts:3322"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const t={},a=i.createContext(t);function o(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{81245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var i=s(24246),t=s(71670);const o={},a="Function: listImages()",r={id:"namespaces/containerEngine/functions/listImages",title:"Function: listImages()",description:"listImages(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listImages.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listImages",permalink:"/api/namespaces/containerEngine/functions/listImages",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listContainers",permalink:"/api/namespaces/containerEngine/functions/listContainers"},next:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"}},c={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-listimages",children:"Function: listImages()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"listImages"}),"(",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"List the container images. Only images from a final layer (no children) are returned."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ListImagesOptions",children:(0,i.jsx)(n.code,{children:"ListImagesOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"optional options for listing images"}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/ImageInfo",children:(0,i.jsx)(n.code,{children:"ImageInfo"})}),"[]>"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise resolving to an array of images information. This method returns a subset of the available information for images. To get the complete description of a specific image, you can use the ",(0,i.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/getImageInspect",children:"containerEngine.getImageInspect"})," method."]}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 1: List all container images when no specific provider is provided.\nconst images = await listImages();\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"// Example 2: List container images for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst images = await listImages({ provider: provider.connection });\nconsole.log(images);\n"})}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3322",children:"packages/extension-api/src/extension-api.d.ts:3322"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>a});var i=s(27378);const t={},o=i.createContext(t);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e2ae3df.df278463.js b/assets/js/7e2ae3df.005331b5.js similarity index 98% rename from assets/js/7e2ae3df.df278463.js rename to assets/js/7e2ae3df.005331b5.js index f57dada7a32..516e0731e22 100644 --- a/assets/js/7e2ae3df.df278463.js +++ b/assets/js/7e2ae3df.005331b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{99597:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{99597:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const s={},o="Function: registerAuthenticationProvider()",a={id:"namespaces/authentication/functions/registerAuthenticationProvider",title:"Function: registerAuthenticationProvider()",description:"registerAuthenticationProvider(id, label, provider, options?): Disposable",source:"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/registerAuthenticationProvider",permalink:"/api/namespaces/authentication/functions/registerAuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"},next:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Params",id:"params",level:2},{value:"Source",id:"source",level:2}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-registerauthenticationprovider",children:"Function: registerAuthenticationProvider()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"registerAuthenticationProvider"}),"(",(0,r.jsx)(n.code,{children:"id"}),", ",(0,r.jsx)(n.code,{children:"label"}),", ",(0,r.jsx)(n.code,{children:"provider"}),", ",(0,r.jsx)(n.code,{children:"options"}),"?): ",(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Register an authentication provider."}),"\n",(0,r.jsx)(n.p,{children:"There can only be one provider per id and an error is being thrown when an id\nhas already been used by another provider. Ids are case-sensitive."}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The unique identifier of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"label"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"The human-readable name of the provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProvider",children:(0,r.jsx)(n.code,{children:"AuthenticationProvider"})})]}),"\n",(0,r.jsx)(n.p,{children:"The authentication provider provider."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"options?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/AuthenticationProviderOptions",children:(0,r.jsx)(n.code,{children:"AuthenticationProviderOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,r.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,r.jsxs)(n.p,{children:["A ",(0,r.jsx)(n.a,{href:"#Disposable",children:"disposable"})," that unregisters this provider when being disposed."]}),"\n",(0,r.jsx)(n.h2,{id:"params",children:"Params"}),"\n",(0,r.jsx)(n.p,{children:"options Additional options for the provider."}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3689",children:"packages/extension-api/src/extension-api.d.ts:3689"})})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>o});var r=i(27378);const t={},s=r.createContext(t);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7e5a2776.834d0188.js b/assets/js/7e5a2776.8aca4f7e.js similarity index 91% rename from assets/js/7e5a2776.834d0188.js rename to assets/js/7e5a2776.8aca4f7e.js index 8b3ee855784..b1cd0518068 100644 --- a/assets/js/7e5a2776.834d0188.js +++ b/assets/js/7e5a2776.8aca4f7e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{61010:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const c={},t="Interface: FileSystemWatcher",d={id:"interfaces/FileSystemWatcher",title:"Interface: FileSystemWatcher",description:"Notifies changes on files or folders.",source:"@site/api/interfaces/FileSystemWatcher.md",sourceDirName:"interfaces",slug:"/interfaces/FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"},next:{title:"GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"}),"\n",(0,i.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidChange"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1410",children:"packages/extension-api/src/extension-api.d.ts:1410"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidCreate"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidDelete"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1411",children:"packages/extension-api/src/extension-api.d.ts:1411"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})," . ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var i=s(27378);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{61010:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const c={},t="Interface: FileSystemWatcher",d={id:"interfaces/FileSystemWatcher",title:"Interface: FileSystemWatcher",description:"Notifies changes on files or folders.",source:"@site/api/interfaces/FileSystemWatcher.md",sourceDirName:"interfaces",slug:"/interfaces/FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"},next:{title:"GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult"}},o={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"onDidChange",id:"ondidchange",level:3},{value:"Source",id:"source",level:4},{value:"onDidCreate",id:"ondidcreate",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidDelete",id:"ondiddelete",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-filesystemwatcher",children:"Interface: FileSystemWatcher"}),"\n",(0,i.jsx)(n.p,{children:"Notifies changes on files or folders."}),"\n",(0,i.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ondidchange",children:"onDidChange"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidChange"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1410",children:"packages/extension-api/src/extension-api.d.ts:1410"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidcreate",children:"onDidCreate"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidCreate"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1409",children:"packages/extension-api/src/extension-api.d.ts:1409"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondiddelete",children:"onDidDelete"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidDelete"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})})," <",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1411",children:"packages/extension-api/src/extension-api.d.ts:1411"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})," . ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable#dispose",children:(0,i.jsx)(n.code,{children:"dispose"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var i=s(27378);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7f0476bd.7c3df3dd.js b/assets/js/7f0476bd.e0aced37.js similarity index 91% rename from assets/js/7f0476bd.7c3df3dd.js rename to assets/js/7f0476bd.e0aced37.js index 480c6be933e..236a071bf3f 100644 --- a/assets/js/7f0476bd.7c3df3dd.js +++ b/assets/js/7f0476bd.e0aced37.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{37354:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=n(24246),r=n(71670);const c={},t="Interface: Webview",o={id:"interfaces/Webview",title:"Interface: Webview",description:"Displays html content, similarly to an iframe.",source:"@site/api/interfaces/Webview.md",sourceDirName:"interfaces",slug:"/interfaces/Webview",permalink:"/api/interfaces/Webview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"},next:{title:"WebviewInfo",permalink:"/api/interfaces/WebviewInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Source",id:"source",level:4},{value:"html",id:"html",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Source",id:"source-2",level:4},{value:"options",id:"options",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"asWebviewUri()",id:"aswebviewuri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-5",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-webview",children:"Interface: Webview"}),"\n",(0,i.jsx)(s.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"cspsource",children:"cspSource"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"cspSource"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content security policy source for webview resources."}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1470",children:"packages/extension-api/src/extension-api.d.ts:1470"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"html",children:"html"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"html"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"HTML contents of the webview."}),"\n",(0,i.jsx)(s.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1447",children:"packages/extension-api/src/extension-api.d.ts:1447"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"onDidReceiveMessage"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"<",(0,i.jsx)(s.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Fired when the webview content posts a message."}),"\n",(0,i.jsx)(s.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1454",children:"packages/extension-api/src/extension-api.d.ts:1454"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"options",children:"options"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"options"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(s.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content settings for the webview."}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1439",children:"packages/extension-api/src/extension-api.d.ts:1439"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"asWebviewUri"}),"(",(0,i.jsx)(s.code,{children:"localResource"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"localResource"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1464",children:"packages/extension-api/src/extension-api.d.ts:1464"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"postMessage"}),"(",(0,i.jsx)(s.code,{children:"message"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Post a message to the webview content."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"message"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1459",children:"packages/extension-api/src/extension-api.d.ts:1459"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>t});var i=n(27378);const r={},c=i.createContext(r);function t(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{37354:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var i=n(24246),r=n(71670);const c={},t="Interface: Webview",o={id:"interfaces/Webview",title:"Interface: Webview",description:"Displays html content, similarly to an iframe.",source:"@site/api/interfaces/Webview.md",sourceDirName:"interfaces",slug:"/interfaces/Webview",permalink:"/api/interfaces/Webview",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"},next:{title:"WebviewInfo",permalink:"/api/interfaces/WebviewInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cspSource",id:"cspsource",level:3},{value:"Source",id:"source",level:4},{value:"html",id:"html",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidReceiveMessage",id:"ondidreceivemessage",level:3},{value:"Source",id:"source-2",level:4},{value:"options",id:"options",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"asWebviewUri()",id:"aswebviewuri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4},{value:"postMessage()",id:"postmessage",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-5",level:4}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-webview",children:"Interface: Webview"}),"\n",(0,i.jsx)(s.p,{children:"Displays html content, similarly to an iframe."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"cspsource",children:"cspSource"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"cspSource"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content security policy source for webview resources."}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1470",children:"packages/extension-api/src/extension-api.d.ts:1470"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"html",children:"html"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"html"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"HTML contents of the webview."}),"\n",(0,i.jsx)(s.p,{children:"This should be a complete, valid html document. Changing this property causes the webview to be reloaded."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1447",children:"packages/extension-api/src/extension-api.d.ts:1447"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"ondidreceivemessage",children:"onDidReceiveMessage"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"onDidReceiveMessage"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})}),"<",(0,i.jsx)(s.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Fired when the webview content posts a message."}),"\n",(0,i.jsx)(s.p,{children:"Webview content can post strings or json serializable objects back to an extension."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1454",children:"packages/extension-api/src/extension-api.d.ts:1454"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"options",children:"options"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"options"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(s.code,{children:"WebviewOptions"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Content settings for the webview."}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1439",children:"packages/extension-api/src/extension-api.d.ts:1439"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"aswebviewuri",children:"asWebviewUri()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"asWebviewUri"}),"(",(0,i.jsx)(s.code,{children:"localResource"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Convert a uri for the local file system to one that can be used inside webviews."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"localResource"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Uri",children:(0,i.jsx)(s.code,{children:"Uri"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1464",children:"packages/extension-api/src/extension-api.d.ts:1464"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"postmessage",children:"postMessage()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"postMessage"}),"(",(0,i.jsx)(s.code,{children:"message"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Post a message to the webview content."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"message"}),": ",(0,i.jsx)(s.code,{children:"unknown"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,i.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1459",children:"packages/extension-api/src/extension-api.d.ts:1459"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>t});var i=n(27378);const r={},c=i.createContext(r);function t(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7fa133e1.326e2756.js b/assets/js/7fa133e1.80e21af8.js similarity index 92% rename from assets/js/7fa133e1.326e2756.js rename to assets/js/7fa133e1.80e21af8.js index ec1a51ecceb..446fc7b801b 100644 --- a/assets/js/7fa133e1.326e2756.js +++ b/assets/js/7fa133e1.80e21af8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{62338:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(24246),i=s(71670);const c={},r="Interface: CustomPickItem",o={id:"interfaces/CustomPickItem",title:"Interface: CustomPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickItem",permalink:"/api/interfaces/CustomPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPick",permalink:"/api/interfaces/CustomPick"},next:{title:"CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Source",id:"source-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-custompickitem",children:"Interface: CustomPickItem"}),"\n",(0,t.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"description"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered less prominent in the same line."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1112",children:"packages/extension-api/src/extension-api.d.ts:1112"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"markDownContent"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1116",children:"packages/extension-api/src/extension-api.d.ts:1116"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sections",children:"sections?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"sections"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CustomPickSectionItem",children:(0,t.jsx)(n.code,{children:"CustomPickSectionItem"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional sections that will be rendered in separate lines"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1120",children:"packages/extension-api/src/extension-api.d.ts:1120"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"selected",children:"selected?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"selected"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional flag indicating if this item is selected initially"}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1124",children:"packages/extension-api/src/extension-api.d.ts:1124"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1108",children:"packages/extension-api/src/extension-api.d.ts:1108"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{62338:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var t=s(24246),i=s(71670);const c={},r="Interface: CustomPickItem",o={id:"interfaces/CustomPickItem",title:"Interface: CustomPickItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickItem",permalink:"/api/interfaces/CustomPickItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPick",permalink:"/api/interfaces/CustomPick"},next:{title:"CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"sections?",id:"sections",level:3},{value:"Source",id:"source-2",level:4},{value:"selected?",id:"selected",level:3},{value:"Source",id:"source-3",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-custompickitem",children:"Interface: CustomPickItem"}),"\n",(0,t.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"description"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered less prominent in the same line."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1112",children:"packages/extension-api/src/extension-api.d.ts:1112"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"markDownContent"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1116",children:"packages/extension-api/src/extension-api.d.ts:1116"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sections",children:"sections?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"sections"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/CustomPickSectionItem",children:(0,t.jsx)(n.code,{children:"CustomPickSectionItem"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional sections that will be rendered in separate lines"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1120",children:"packages/extension-api/src/extension-api.d.ts:1120"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"selected",children:"selected?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"selected"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Optional flag indicating if this item is selected initially"}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1124",children:"packages/extension-api/src/extension-api.d.ts:1124"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1108",children:"packages/extension-api/src/extension-api.d.ts:1108"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814402d7.73f5f1a0.js b/assets/js/814402d7.a4ccc74d.js similarity index 87% rename from assets/js/814402d7.73f5f1a0.js rename to assets/js/814402d7.a4ccc74d.js index ffa1225def1..a708f44974e 100644 --- a/assets/js/814402d7.73f5f1a0.js +++ b/assets/js/814402d7.a4ccc74d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{49272:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var t=i(24246),s=i(71670);const o={},r="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",a={id:"interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"},next:{title:"AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Source",id:"source",level:4},{value:"changed?",id:"changed",level:3},{value:"Source",id:"source-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"added",children:"added?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"added"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been added."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3570",children:"packages/extension-api/src/extension-api.d.ts:3570"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"changed",children:"changed?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"changed"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been changed.\nA session changes when its data excluding the id are updated. An example of this is a session refresh that results in a new\naccess token being set for the session."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3582",children:"packages/extension-api/src/extension-api.d.ts:3582"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"removed",children:"removed?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"removed"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been removed."]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3575",children:"packages/extension-api/src/extension-api.d.ts:3575"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{49272:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const o={},r="Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",c={id:"interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",title:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent",description:"An event which fires when an AuthenticationSession is added, removed, or changed.",source:"@site/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"},next:{title:"AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"added?",id:"added",level:3},{value:"Source",id:"source",level:4},{value:"changed?",id:"changed",level:3},{value:"Source",id:"source-1",level:4},{value:"removed?",id:"removed",level:3},{value:"Source",id:"source-2",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationproviderauthenticationsessionschangeevent",children:"Interface: AuthenticationProviderAuthenticationSessionsChangeEvent"}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"#Event",children:"event"})," which fires when an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," is added, removed, or changed."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"added",children:"added?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"added"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been added."]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3570",children:"packages/extension-api/src/extension-api.d.ts:3570"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"changed",children:"changed?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"changed"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been changed.\nA session changes when its data excluding the id are updated. An example of this is a session refresh that results in a new\naccess token being set for the session."]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3582",children:"packages/extension-api/src/extension-api.d.ts:3582"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"removed",children:"removed?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"removed"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,t.jsx)(n.code,{children:"AuthenticationSession"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"s of the ",(0,t.jsx)(n.a,{href:"#AuthentiationProvider",children:"AuthenticationProvider"})," that have been removed."]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3575",children:"packages/extension-api/src/extension-api.d.ts:3575"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/814d49b7.573f5bd3.js b/assets/js/814d49b7.40814d6c.js similarity index 89% rename from assets/js/814d49b7.573f5bd3.js rename to assets/js/814d49b7.40814d6c.js index 42935489b2b..a2c0a789353 100644 --- a/assets/js/814d49b7.573f5bd3.js +++ b/assets/js/814d49b7.40814d6c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{12005:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolUpdateOptions",c={id:"interfaces/CliToolUpdateOptions",title:"Interface: CliToolUpdateOptions",description:"Options to update CliTool instance",source:"@site/api/interfaces/CliToolUpdateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"},next:{title:"Clipboard",permalink:"/api/interfaces/Clipboard"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"path?",id:"path",level:3},{value:"Source",id:"source-3",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4060",children:"packages/extension-api/src/extension-api.d.ts:4060"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4062",children:"packages/extension-api/src/extension-api.d.ts:4062"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4061",children:"packages/extension-api/src/extension-api.d.ts:4061"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4063",children:"packages/extension-api/src/extension-api.d.ts:4063"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4059",children:"packages/extension-api/src/extension-api.d.ts:4059"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{12005:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(24246),o=s(71670);const t={},r="Interface: CliToolUpdateOptions",c={id:"interfaces/CliToolUpdateOptions",title:"Interface: CliToolUpdateOptions",description:"Options to update CliTool instance",source:"@site/api/interfaces/CliToolUpdateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate"},next:{title:"Clipboard",permalink:"/api/interfaces/Clipboard"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"displayName?",id:"displayname",level:3},{value:"Source",id:"source",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-2",level:4},{value:"path?",id:"path",level:3},{value:"Source",id:"source-3",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-clitoolupdateoptions",children:"Interface: CliToolUpdateOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to update CliTool instance"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"displayname",children:"displayName?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"displayName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4060",children:"packages/extension-api/src/extension-api.d.ts:4060"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4062",children:"packages/extension-api/src/extension-api.d.ts:4062"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4061",children:"packages/extension-api/src/extension-api.d.ts:4061"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"path?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4063",children:"packages/extension-api/src/extension-api.d.ts:4063"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4059",children:"packages/extension-api/src/extension-api.d.ts:4059"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/81b69ac7.46806224.js b/assets/js/81b69ac7.43258e3d.js similarity index 94% rename from assets/js/81b69ac7.46806224.js rename to assets/js/81b69ac7.43258e3d.js index 1f3c0ce238e..5a3119dbf40 100644 --- a/assets/js/81b69ac7.46806224.js +++ b/assets/js/81b69ac7.43258e3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{63500:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(24246),t=i(71670);const o={},c="Interface: KubernetesProviderConnectionFactory",s={id:"interfaces/KubernetesProviderConnectionFactory",title:"Interface: KubernetesProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/KubernetesProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"},next:{title:"LifecycleContext",permalink:"/api/interfaces/LifecycleContext"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()?",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L366",children:"packages/extension-api/src/extension-api.d.ts:366"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{63500:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>a});var r=i(24246),t=i(71670);const o={},c="Interface: KubernetesProviderConnectionFactory",s={id:"interfaces/KubernetesProviderConnectionFactory",title:"Interface: KubernetesProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/KubernetesProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnectionFactory",permalink:"/api/interfaces/KubernetesProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"},next:{title:"LifecycleContext",permalink:"/api/interfaces/LifecycleContext"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()?",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-kubernetesproviderconnectionfactory",children:"Interface: KubernetesProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L366",children:"packages/extension-api/src/extension-api.d.ts:366"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const t={},o=r.createContext(t);function c(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/82170cf7.da652198.js b/assets/js/82170cf7.5444f2e9.js similarity index 96% rename from assets/js/82170cf7.da652198.js rename to assets/js/82170cf7.5444f2e9.js index af0def50ecc..555bc88e4ef 100644 --- a/assets/js/82170cf7.da652198.js +++ b/assets/js/82170cf7.5444f2e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{95261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Function: getImageInspect()",o={id:"namespaces/containerEngine/functions/getImageInspect",title:"Function: getImageInspect()",description:"getImageInspect(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/getImageInspect.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"},next:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getImageInspect"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),"): ",(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return low-level information about an image"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3379",children:"packages/extension-api/src/extension-api.d.ts:3379"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{95261:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Function: getImageInspect()",o={id:"namespaces/containerEngine/functions/getImageInspect",title:"Function: getImageInspect()",description:"getImageInspect(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/getImageInspect.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/getImageInspect",permalink:"/api/namespaces/containerEngine/functions/getImageInspect",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"deleteVolume",permalink:"/api/namespaces/containerEngine/functions/deleteVolume"},next:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getimageinspect",children:"Function: getImageInspect()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getImageInspect"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),"): ",(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Return low-level information about an image"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/ImageInspectInfo",children:(0,s.jsx)(n.code,{children:"ImageInspectInfo"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"A promise resolving to a structure containing the image information"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3379",children:"packages/extension-api/src/extension-api.d.ts:3379"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/825ec378.ebeff3f5.js b/assets/js/825ec378.fc7bba51.js similarity index 98% rename from assets/js/825ec378.ebeff3f5.js rename to assets/js/825ec378.fc7bba51.js index 6a6b5852848..f1102e7441a 100644 --- a/assets/js/825ec378.ebeff3f5.js +++ b/assets/js/825ec378.fc7bba51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{71998:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Function: buildImage()",o={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"},next:{title:"createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3290",children:"packages/extension-api/src/extension-api.d.ts:3290"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{71998:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Function: buildImage()",o={id:"namespaces/containerEngine/functions/buildImage",title:"Function: buildImage()",description:"buildImage(context, eventCollect, options?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/buildImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: containerEngine",permalink:"/api/namespaces/containerEngine/"},next:{title:"createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-buildimage",children:"Function: buildImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"buildImage"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"eventCollect"}),", ",(0,t.jsx)(n.code,{children:"options"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Build a container image"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the build context directory"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"eventCollect"})]}),"\n",(0,t.jsxs)(n.p,{children:["a function called when new build logs are emitted or new events happen during the build operation. The value of ",(0,t.jsx)(n.code,{children:"eventName"})," can be either ",(0,t.jsx)(n.code,{children:"stream"})," (and ",(0,t.jsx)(n.code,{children:"data"})," contains the logs), or ",(0,t.jsx)(n.code,{children:"finish"})," indicating the end of the build operation, or ",(0,t.jsx)(n.code,{children:"error"})," in case of build error (and ",(0,t.jsx)(n.code,{children:"data"})," contains the error message)"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/BuildImageOptions",children:(0,t.jsx)(n.code,{children:"BuildImageOptions"})})]}),"\n",(0,t.jsx)(n.p,{children:"parameters for the build operation"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3290",children:"packages/extension-api/src/extension-api.d.ts:3290"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8519c2b0.b35b1e1a.js b/assets/js/8519c2b0.49d73a83.js similarity index 98% rename from assets/js/8519c2b0.b35b1e1a.js rename to assets/js/8519c2b0.49d73a83.js index 9586a2217a6..064011254ae 100644 --- a/assets/js/8519c2b0.b35b1e1a.js +++ b/assets/js/8519c2b0.49d73a83.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{17883:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=n(24246),o=n(71670);const t={},i="Function: showErrorMessage()",c={id:"namespaces/window/functions/showErrorMessage",title:"Function: showErrorMessage()",description:"showErrorMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showErrorMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listWebviews",permalink:"/api/namespaces/window/functions/listWebviews"},next:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1650",children:"packages/extension-api/src/extension-api.d.ts:1650"})})]})}function h(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var r=n(27378);const o={},t=r.createContext(o);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{17883:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=n(24246),o=n(71670);const t={},i="Function: showErrorMessage()",c={id:"namespaces/window/functions/showErrorMessage",title:"Function: showErrorMessage()",description:"showErrorMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showErrorMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listWebviews",permalink:"/api/namespaces/window/functions/listWebviews"},next:{title:"showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"function-showerrormessage",children:"Function: showErrorMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"showErrorMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),", ...",(0,r.jsx)(s.code,{children:"items"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Show a error message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,r.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The message to show."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"items"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,r.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"undefined"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["A promise that resolves to the selected item or ",(0,r.jsx)(s.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,r.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1650",children:"packages/extension-api/src/extension-api.d.ts:1650"})})]})}function h(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>i});var r=n(27378);const o={},t=r.createContext(o);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86e64757.85231160.js b/assets/js/86e64757.44ad7428.js similarity index 94% rename from assets/js/86e64757.85231160.js rename to assets/js/86e64757.44ad7428.js index 1782a3c78b9..7b2e2823e5e 100644 --- a/assets/js/86e64757.85231160.js +++ b/assets/js/86e64757.44ad7428.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{44491:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=s(24246),a=s(71670);const r={},i="Variable: isTelemetryEnabled",o={id:"namespaces/env/variables/isTelemetryEnabled",title:"Variable: isTelemetryEnabled",description:"const isTelemetryEnabled: boolean",source:"@site/api/namespaces/env/variables/isTelemetryEnabled.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isMac",permalink:"/api/namespaces/env/variables/isMac"},next:{title:"isWindows",permalink:"/api/namespaces/env/variables/isWindows"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3729",children:"packages/extension-api/src/extension-api.d.ts:3729"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const a={},r=t.createContext(a);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{44491:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var t=s(24246),a=s(71670);const r={},i="Variable: isTelemetryEnabled",o={id:"namespaces/env/variables/isTelemetryEnabled",title:"Variable: isTelemetryEnabled",description:"const isTelemetryEnabled: boolean",source:"@site/api/namespaces/env/variables/isTelemetryEnabled.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isMac",permalink:"/api/namespaces/env/variables/isMac"},next:{title:"isWindows",permalink:"/api/namespaces/env/variables/isWindows"}},c={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"variable-istelemetryenabled",children:"Variable: isTelemetryEnabled"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"const"})," ",(0,t.jsx)(n.strong,{children:"isTelemetryEnabled"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Indicates whether the users has telemetry enabled.\nCan be observed to determine if the extension should send telemetry."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3729",children:"packages/extension-api/src/extension-api.d.ts:3729"})})]})}function p(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const a={},r=t.createContext(a);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86f8c256.699944b6.js b/assets/js/86f8c256.b8937dcb.js similarity index 91% rename from assets/js/86f8c256.699944b6.js rename to assets/js/86f8c256.b8937dcb.js index 49038b3c3fb..f3ee9ccab69 100644 --- a/assets/js/86f8c256.699944b6.js +++ b/assets/js/86f8c256.b8937dcb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{11457:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>a,frontMatter:()=>c,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const c={},r="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Source",id:"source",level:4},{value:"Author",id:"author",level:3},{value:"Source",id:"source-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Source",id:"source-2",level:4},{value:"Config",id:"config",level:3},{value:"ArgsEscaped",id:"argsescaped",level:4},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-3",level:4},{value:"Container",id:"container",level:3},{value:"Source",id:"source-4",level:4},{value:"ContainerConfig",id:"containerconfig",level:3},{value:"ArgsEscaped",id:"argsescaped-1",level:4},{value:"AttachStderr",id:"attachstderr-1",level:4},{value:"AttachStdin",id:"attachstdin-1",level:4},{value:"AttachStdout",id:"attachstdout-1",level:4},{value:"Cmd",id:"cmd-1",level:4},{value:"Domainname",id:"domainname-1",level:4},{value:"Entrypoint?",id:"entrypoint-1",level:4},{value:"Env",id:"env-1",level:4},{value:"ExposedPorts",id:"exposedports-1",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Hostname",id:"hostname-1",level:4},{value:"Image",id:"image-1",level:4},{value:"Labels",id:"labels-1",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"OnBuild?",id:"onbuild-1",level:4},{value:"OpenStdin",id:"openstdin-1",level:4},{value:"StdinOnce",id:"stdinonce-1",level:4},{value:"Tty",id:"tty-1",level:4},{value:"User",id:"user-1",level:4},{value:"Volumes",id:"volumes-1",level:4},{value:"Index signature",id:"index-signature-5",level:5},{value:"WorkingDir",id:"workingdir-1",level:4},{value:"Source",id:"source-5",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Source",id:"source-7",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-8",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-9",level:4},{value:"Os",id:"os",level:3},{value:"Source",id:"source-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Source",id:"source-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Source",id:"source-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-13",level:4},{value:"RootFS",id:"rootfs",level:3},{value:"BaseLayer?",id:"baselayer",level:4},{value:"Layers?",id:"layers",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-14",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-18",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Architecture"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1969",children:"packages/extension-api/src/extension-api.d.ts:1969"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Author"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1947",children:"packages/extension-api/src/extension-api.d.ts:1947"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Comment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1922",children:"packages/extension-api/src/extension-api.d.ts:1922"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1948",children:"packages/extension-api/src/extension-api.d.ts:1948"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Container"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1924",children:"packages/extension-api/src/extension-api.d.ts:1924"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-5",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1925",children:"packages/extension-api/src/extension-api.d.ts:1925"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1923",children:"packages/extension-api/src/extension-api.d.ts:1923"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1946",children:"packages/extension-api/src/extension-api.d.ts:1946"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1973",children:"packages/extension-api/src/extension-api.d.ts:1973"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1918",children:"packages/extension-api/src/extension-api.d.ts:1918"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Os"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1970",children:"packages/extension-api/src/extension-api.d.ts:1970"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Parent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1921",children:"packages/extension-api/src/extension-api.d.ts:1921"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1920",children:"packages/extension-api/src/extension-api.d.ts:1920"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1919",children:"packages/extension-api/src/extension-api.d.ts:1919"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RootFS"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BaseLayer"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Layers"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1981",children:"packages/extension-api/src/extension-api.d.ts:1981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1972",children:"packages/extension-api/src/extension-api.d.ts:1972"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1916",children:"packages/extension-api/src/extension-api.d.ts:1916"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1917",children:"packages/extension-api/src/extension-api.d.ts:1917"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>r});var i=s(27378);const d={},c=i.createContext(d);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{11457:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>l,toc:()=>t});var i=s(24246),c=s(71670);const d={},r="Interface: ImageInspectInfo",l={id:"interfaces/ImageInspectInfo",title:"Interface: ImageInspectInfo",description:"Properties",source:"@site/api/interfaces/ImageInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInfo",permalink:"/api/interfaces/ImageInfo"},next:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"Architecture",id:"architecture",level:3},{value:"Source",id:"source",level:4},{value:"Author",id:"author",level:3},{value:"Source",id:"source-1",level:4},{value:"Comment",id:"comment",level:3},{value:"Source",id:"source-2",level:4},{value:"Config",id:"config",level:3},{value:"ArgsEscaped",id:"argsescaped",level:4},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-3",level:4},{value:"Container",id:"container",level:3},{value:"Source",id:"source-4",level:4},{value:"ContainerConfig",id:"containerconfig",level:3},{value:"ArgsEscaped",id:"argsescaped-1",level:4},{value:"AttachStderr",id:"attachstderr-1",level:4},{value:"AttachStdin",id:"attachstdin-1",level:4},{value:"AttachStdout",id:"attachstdout-1",level:4},{value:"Cmd",id:"cmd-1",level:4},{value:"Domainname",id:"domainname-1",level:4},{value:"Entrypoint?",id:"entrypoint-1",level:4},{value:"Env",id:"env-1",level:4},{value:"ExposedPorts",id:"exposedports-1",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Hostname",id:"hostname-1",level:4},{value:"Image",id:"image-1",level:4},{value:"Labels",id:"labels-1",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"OnBuild?",id:"onbuild-1",level:4},{value:"OpenStdin",id:"openstdin-1",level:4},{value:"StdinOnce",id:"stdinonce-1",level:4},{value:"Tty",id:"tty-1",level:4},{value:"User",id:"user-1",level:4},{value:"Volumes",id:"volumes-1",level:4},{value:"Index signature",id:"index-signature-5",level:5},{value:"WorkingDir",id:"workingdir-1",level:4},{value:"Source",id:"source-5",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-6",level:4},{value:"DockerVersion",id:"dockerversion",level:3},{value:"Source",id:"source-7",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-8",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-9",level:4},{value:"Os",id:"os",level:3},{value:"Source",id:"source-10",level:4},{value:"Parent",id:"parent",level:3},{value:"Source",id:"source-11",level:4},{value:"RepoDigests",id:"repodigests",level:3},{value:"Source",id:"source-12",level:4},{value:"RepoTags",id:"repotags",level:3},{value:"Source",id:"source-13",level:4},{value:"RootFS",id:"rootfs",level:3},{value:"BaseLayer?",id:"baselayer",level:4},{value:"Layers?",id:"layers",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-14",level:4},{value:"Size",id:"size",level:3},{value:"Source",id:"source-15",level:4},{value:"VirtualSize",id:"virtualsize",level:3},{value:"Source",id:"source-16",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-17",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-18",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-imageinspectinfo",children:"Interface: ImageInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"architecture",children:"Architecture"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Architecture"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1969",children:"packages/extension-api/src/extension-api.d.ts:1969"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"author",children:"Author"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Author"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1947",children:"packages/extension-api/src/extension-api.d.ts:1947"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"comment",children:"Comment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Comment"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1922",children:"packages/extension-api/src/extension-api.d.ts:1922"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1948",children:"packages/extension-api/src/extension-api.d.ts:1948"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"container",children:"Container"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Container"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1924",children:"packages/extension-api/src/extension-api.d.ts:1924"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containerconfig",children:"ContainerConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ContainerConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"argsescaped-1",children:"ArgsEscaped"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ArgsEscaped"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr-1",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin-1",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout-1",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd-1",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname-1",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint-1",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env-1",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports-1",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname-1",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels-1",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild-1",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin-1",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce-1",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty-1",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user-1",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes-1",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-5",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"path"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir-1",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1925",children:"packages/extension-api/src/extension-api.d.ts:1925"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1923",children:"packages/extension-api/src/extension-api.d.ts:1923"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dockerversion",children:"DockerVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DockerVersion"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1946",children:"packages/extension-api/src/extension-api.d.ts:1946"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1973",children:"packages/extension-api/src/extension-api.d.ts:1973"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1918",children:"packages/extension-api/src/extension-api.d.ts:1918"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"os",children:"Os"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Os"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1970",children:"packages/extension-api/src/extension-api.d.ts:1970"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"parent",children:"Parent"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Parent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1921",children:"packages/extension-api/src/extension-api.d.ts:1921"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repodigests",children:"RepoDigests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoDigests"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1920",children:"packages/extension-api/src/extension-api.d.ts:1920"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"repotags",children:"RepoTags"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RepoTags"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1919",children:"packages/extension-api/src/extension-api.d.ts:1919"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"rootfs",children:"RootFS"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RootFS"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"baselayer",children:"BaseLayer?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BaseLayer"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"layers",children:"Layers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Layers"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1981",children:"packages/extension-api/src/extension-api.d.ts:1981"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"size",children:"Size"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Size"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1971",children:"packages/extension-api/src/extension-api.d.ts:1971"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"virtualsize",children:"VirtualSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"VirtualSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1972",children:"packages/extension-api/src/extension-api.d.ts:1972"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1916",children:"packages/extension-api/src/extension-api.d.ts:1916"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1917",children:"packages/extension-api/src/extension-api.d.ts:1917"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>r});var i=s(27378);const c={},d=i.createContext(c);function r(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/871ce139.d97a8766.js b/assets/js/871ce139.a79f0432.js similarity index 94% rename from assets/js/871ce139.d97a8766.js rename to assets/js/871ce139.a79f0432.js index 38dfaac9752..87e0ebf1379 100644 --- a/assets/js/871ce139.d97a8766.js +++ b/assets/js/871ce139.a79f0432.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{54790:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>p});var r=n(24246),o=n(71670);const s={},i="Interface: NetworkCreateOptions",a={id:"interfaces/NetworkCreateOptions",title:"Interface: NetworkCreateOptions",description:"Properties",source:"@site/api/interfaces/NetworkCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkContainer",permalink:"/api/interfaces/NetworkContainer"},next:{title:"NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"}},c={},p=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3085",children:"packages/extension-api/src/extension-api.d.ts:3085"})})]})}function l(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(27378);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{54790:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>p});var r=n(24246),o=n(71670);const s={},i="Interface: NetworkCreateOptions",a={id:"interfaces/NetworkCreateOptions",title:"Interface: NetworkCreateOptions",description:"Properties",source:"@site/api/interfaces/NetworkCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkContainer",permalink:"/api/interfaces/NetworkContainer"},next:{title:"NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult"}},c={},p=[{value:"Properties",id:"properties",level:2},{value:"Name",id:"name",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-networkcreateoptions",children:"Interface: NetworkCreateOptions"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"Name"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3085",children:"packages/extension-api/src/extension-api.d.ts:3085"})})]})}function l(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>i});var r=n(27378);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/874690d0.52f3811f.js b/assets/js/874690d0.ddbbd135.js similarity index 85% rename from assets/js/874690d0.52f3811f.js rename to assets/js/874690d0.ddbbd135.js index ae6a52efeda..fa4a771a84b 100644 --- a/assets/js/874690d0.52f3811f.js +++ b/assets/js/874690d0.ddbbd135.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{45652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const r={},o="Interface: StatusBarItem",c={id:"interfaces/StatusBarItem",title:"Interface: StatusBarItem",description:"A status bar item is a status bar contribution that can",source:"@site/api/interfaces/StatusBarItem.md",sourceDirName:"interfaces",slug:"/interfaces/StatusBarItem",permalink:"/api/interfaces/StatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"},next:{title:"StorageStats",permalink:"/api/interfaces/StorageStats"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Source",id:"source",level:4},{value:"command?",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Source",id:"source-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Source",id:"source-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Source",id:"source-4",level:4},{value:"priority",id:"priority",level:3},{value:"Source",id:"source-5",level:4},{value:"text?",id:"text",level:3},{value:"Source",id:"source-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"}),"\n",(0,i.jsx)(n.p,{children:"A status bar item is a status bar contribution that can\nshow text and icons and run a command on click."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"alignment"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,i.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,i.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1271",children:"packages/extension-api/src/extension-api.d.ts:1271"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"commandArgs"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1276",children:"packages/extension-api/src/extension-api.d.ts:1276"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Marks an item as disabled. When property is set to true, then icon will be changed to inactive\nand there won't be possible to execute a command if it is provided in the following configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1267",children:"packages/extension-api/src/extension-api.d.ts:1267"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"iconClass"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon class that is used to display the particular icon from the Font Awesome icon set.\nIcon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons\nfor state which can be enabled or disabled."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1262",children:"packages/extension-api/src/extension-api.d.ts:1262"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priority",children:"priority"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"priority"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The priority of this item. Higher value means the item should be shown more to the left\nor more to the right."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1248",children:"packages/extension-api/src/extension-api.d.ts:1248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"text",children:"text?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"text"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1252",children:"packages/extension-api/src/extension-api.d.ts:1252"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1256",children:"packages/extension-api/src/extension-api.d.ts:1256"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1290",children:"packages/extension-api/src/extension-api.d.ts:1290"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1284",children:"packages/extension-api/src/extension-api.d.ts:1284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1280",children:"packages/extension-api/src/extension-api.d.ts:1280"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{45652:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>a});var i=s(24246),t=s(71670);const r={},c="Interface: StatusBarItem",o={id:"interfaces/StatusBarItem",title:"Interface: StatusBarItem",description:"A status bar item is a status bar contribution that can",source:"@site/api/interfaces/StatusBarItem.md",sourceDirName:"interfaces",slug:"/interfaces/StatusBarItem",permalink:"/api/interfaces/StatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent"},next:{title:"StorageStats",permalink:"/api/interfaces/StorageStats"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"alignment",id:"alignment",level:3},{value:"Source",id:"source",level:4},{value:"command?",id:"command",level:3},{value:"Source",id:"source-1",level:4},{value:"commandArgs?",id:"commandargs",level:3},{value:"Source",id:"source-2",level:4},{value:"enabled",id:"enabled",level:3},{value:"Source",id:"source-3",level:4},{value:"iconClass?",id:"iconclass",level:3},{value:"Source",id:"source-4",level:4},{value:"priority",id:"priority",level:3},{value:"Source",id:"source-5",level:4},{value:"text?",id:"text",level:3},{value:"Source",id:"source-6",level:4},{value:"tooltip?",id:"tooltip",level:3},{value:"Source",id:"source-7",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-8",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-9",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-10",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-statusbaritem",children:"Interface: StatusBarItem"}),"\n",(0,i.jsx)(n.p,{children:"A status bar item is a status bar contribution that can\nshow text and icons and run a command on click."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"alignment",children:"alignment"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"alignment"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,i.jsx)(n.code,{children:"StatusBarAlignment"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The alignment of this item."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1243",children:"packages/extension-api/src/extension-api.d.ts:1243"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The identifier of a command, previously registered with ",(0,i.jsx)(n.a,{href:"/api/namespaces/commands/functions/registerCommand",children:"commands.registerCommand"}),", to run on click."]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1271",children:"packages/extension-api/src/extension-api.d.ts:1271"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"commandargs",children:"commandArgs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"commandArgs"}),": ",(0,i.jsx)(n.code,{children:"any"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Arguments that the command handler should be invoked with."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1276",children:"packages/extension-api/src/extension-api.d.ts:1276"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enabled",children:"enabled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"enabled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Marks an item as disabled. When property is set to true, then icon will be changed to inactive\nand there won't be possible to execute a command if it is provided in the following configuration."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1267",children:"packages/extension-api/src/extension-api.d.ts:1267"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"iconclass",children:"iconClass?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"iconClass"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Icon class that is used to display the particular icon from the Font Awesome icon set.\nIcon class should be in format e.g. 'fa fa-toggle-on'. It is possible to provide an icons\nfor state which can be enabled or disabled."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1262",children:"packages/extension-api/src/extension-api.d.ts:1262"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"priority",children:"priority"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"priority"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The priority of this item. Higher value means the item should be shown more to the left\nor more to the right."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1248",children:"packages/extension-api/src/extension-api.d.ts:1248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"text",children:"text?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"text"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to show for the entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1252",children:"packages/extension-api/src/extension-api.d.ts:1252"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"tooltip"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The tooltip text when you hover over this entry."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1256",children:"packages/extension-api/src/extension-api.d.ts:1256"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/StatusBarItem#hide",children:"StatusBarItem.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1290",children:"packages/extension-api/src/extension-api.d.ts:1290"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1284",children:"packages/extension-api/src/extension-api.d.ts:1284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the entry in the status bar."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1280",children:"packages/extension-api/src/extension-api.d.ts:1280"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8785b74d.5573d395.js b/assets/js/8785b74d.c090ee62.js similarity index 89% rename from assets/js/8785b74d.5573d395.js rename to assets/js/8785b74d.c090ee62.js index d4d3200766a..dd3164406e6 100644 --- a/assets/js/8785b74d.5573d395.js +++ b/assets/js/8785b74d.c090ee62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{43791:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>d,toc:()=>a});var s=r(24246),t=r(71670);const i={},o="Interface: TelemetryLogger",d={id:"interfaces/TelemetryLogger",title:"Interface: TelemetryLogger",description:"A telemetry logger which can be used by extensions to log usage and error telementry.",source:"@site/api/interfaces/TelemetryLogger.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StorageStats",permalink:"/api/interfaces/StorageStats"},next:{title:"TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Source",id:"source",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4},{value:"logError()",id:"logerror",level:3},{value:"logError(eventName, data)",id:"logerroreventname-data",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-4",level:5},{value:"logError(error, data)",id:"logerrorerror-data",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Source",id:"source-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-6",level:4}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3909",children:"packages/extension-api/src/extension-api.d.ts:3909"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isusageenabled",children:"isUsageEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isUsageEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not usage telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3904",children:"packages/extension-api/src/extension-api.d.ts:3904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidchangeenablestates",children:"onDidChangeEnableStates"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"onDidChangeEnableStates"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,s.jsx)(n.code,{children:"TelemetryLogger"})}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the enablement state of usage or error telemetry changes."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3899",children:"packages/extension-api/src/extension-api.d.ts:3899"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dispose this object and free resources."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3944",children:"packages/extension-api/src/extension-api.d.ts:3944"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logerror",children:"logError()"}),"\n",(0,s.jsx)(n.h4,{id:"logerroreventname-data",children:"logError(eventName, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event. Differs from ",(0,s.jsx)(n.code,{children:"logUsage"})," in that it will log the event if the telemetry setting is Error+.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3931",children:"packages/extension-api/src/extension-api.d.ts:3931"})}),"\n",(0,s.jsx)(n.h4,{id:"logerrorerror-data",children:"logError(error, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error object which contains the stack trace cleaned of PII"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Additional data to log alongside the stack trace"}),"\n",(0,s.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3939",children:"packages/extension-api/src/extension-api.d.ts:3939"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logusage",children:"logUsage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logUsage"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log a usage event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3920",children:"packages/extension-api/src/extension-api.d.ts:3920"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{43791:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=r(24246),t=r(71670);const i={},o="Interface: TelemetryLogger",c={id:"interfaces/TelemetryLogger",title:"Interface: TelemetryLogger",description:"A telemetry logger which can be used by extensions to log usage and error telementry.",source:"@site/api/interfaces/TelemetryLogger.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StorageStats",permalink:"/api/interfaces/StorageStats"},next:{title:"TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"isErrorsEnabled",id:"iserrorsenabled",level:3},{value:"Source",id:"source",level:4},{value:"isUsageEnabled",id:"isusageenabled",level:3},{value:"Source",id:"source-1",level:4},{value:"onDidChangeEnableStates",id:"ondidchangeenablestates",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4},{value:"logError()",id:"logerror",level:3},{value:"logError(eventName, data)",id:"logerroreventname-data",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Source",id:"source-4",level:5},{value:"logError(error, data)",id:"logerrorerror-data",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Source",id:"source-5",level:5},{value:"logUsage()",id:"logusage",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-6",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-telemetrylogger",children:"Interface: TelemetryLogger"}),"\n",(0,s.jsx)(n.p,{children:"A telemetry logger which can be used by extensions to log usage and error telementry."}),"\n",(0,s.jsxs)(n.p,{children:["A logger wraps around an ",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetrySender",children:"sender"})," but it guarantees that"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"user settings to disable or tweak telemetry are respected, and that"}),"\n",(0,s.jsx)(n.li,{children:"potential sensitive data is removed"}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'It also enables an "echo UI" that prints whatever data is send and it allows the editor\nto forward unhandled errors to the respective extensions.'}),"\n",(0,s.jsxs)(n.p,{children:["To get an instance of a ",(0,s.jsx)(n.code,{children:"TelemetryLogger"}),", use\n",(0,s.jsx)(n.a,{href:"/api/namespaces/env/functions/createTelemetryLogger",children:(0,s.jsx)(n.code,{children:"createTelemetryLogger"})}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iserrorsenabled",children:"isErrorsEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isErrorsEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not error telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3909",children:"packages/extension-api/src/extension-api.d.ts:3909"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isusageenabled",children:"isUsageEnabled"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"isUsageEnabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Whether or not usage telemetry is enabled for this logger."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3904",children:"packages/extension-api/src/extension-api.d.ts:3904"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ondidchangeenablestates",children:"onDidChangeEnableStates"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"onDidChangeEnableStates"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:(0,s.jsx)(n.code,{children:"TelemetryLogger"})}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the enablement state of usage or error telemetry changes."]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3899",children:"packages/extension-api/src/extension-api.d.ts:3899"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"dispose"}),"(): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dispose this object and free resources."}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3944",children:"packages/extension-api/src/extension-api.d.ts:3944"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logerror",children:"logError()"}),"\n",(0,s.jsx)(n.h4,{id:"logerroreventname-data",children:"logError(eventName, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event. Differs from ",(0,s.jsx)(n.code,{children:"logUsage"})," in that it will log the event if the telemetry setting is Error+.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3931",children:"packages/extension-api/src/extension-api.d.ts:3931"})}),"\n",(0,s.jsx)(n.h4,{id:"logerrorerror-data",children:"logError(error, data)"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logError"}),"(",(0,s.jsx)(n.code,{children:"error"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log an error event."}),"\n",(0,s.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"error"}),": ",(0,s.jsx)(n.code,{children:"Error"})]}),"\n",(0,s.jsx)(n.p,{children:"The error object which contains the stack trace cleaned of PII"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"Additional data to log alongside the stack trace"}),"\n",(0,s.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h5,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3939",children:"packages/extension-api/src/extension-api.d.ts:3939"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"logusage",children:"logUsage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"logUsage"}),"(",(0,s.jsx)(n.code,{children:"eventName"}),", ",(0,s.jsx)(n.code,{children:"data"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Log a usage event."}),"\n",(0,s.jsxs)(n.p,{children:["After completing cleaning, telemetry setting checks, and data mix-in calls ",(0,s.jsx)(n.code,{children:"TelemetrySender.sendEventData"})," to log the event.\nAutomatically supports echoing to extension telemetry output channel."]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"eventName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"The event name to log"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"data?"}),": ",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"The data to log"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3920",children:"packages/extension-api/src/extension-api.d.ts:3920"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var s=r(27378);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/878aa0e7.0bd0db54.js b/assets/js/878aa0e7.dcc083a2.js similarity index 92% rename from assets/js/878aa0e7.0bd0db54.js rename to assets/js/878aa0e7.dcc083a2.js index 6b53823e2de..a70535a4d07 100644 --- a/assets/js/878aa0e7.0bd0db54.js +++ b/assets/js/878aa0e7.dcc083a2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{12972:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var t=o(24246),i=o(71670);const r={},s="Type alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type alias: ConfigurationScope"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L700",children:"packages/extension-api/src/extension-api.d.ts:700"})})]})}function d(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>s});var t=o(27378);const i={},r=t.createContext(i);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{12972:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>p});var t=o(24246),i=o(71670);const r={},s="Type alias: ConfigurationScope",a={id:"type-aliases/ConfigurationScope",title:"Type alias: ConfigurationScope",description:"ConfigurationScope: string \\| ContainerProviderConnection \\| KubernetesProviderConnection",source:"@site/api/type-aliases/ConfigurationScope.md",sourceDirName:"type-aliases",slug:"/type-aliases/ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"},next:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"type-alias-configurationscope",children:"Type alias: ConfigurationScope"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"ConfigurationScope"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,t.jsx)(n.code,{children:"ContainerProviderConnection"})})," | ",(0,t.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,t.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The configuration scope"}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L700",children:"packages/extension-api/src/extension-api.d.ts:700"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>s});var t=o(27378);const i={},r=t.createContext(i);function s(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/87a5fc8a.5a42d2be.js b/assets/js/87a5fc8a.1e276eb5.js similarity index 78% rename from assets/js/87a5fc8a.5a42d2be.js rename to assets/js/87a5fc8a.1e276eb5.js index 759cec12cf0..d426c55e22c 100644 --- a/assets/js/87a5fc8a.5a42d2be.js +++ b/assets/js/87a5fc8a.1e276eb5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{56268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="Interface: PidsStats",c={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"current?",id:"current",level:3},{value:"Source",id:"source",level:4},{value:"limit?",id:"limit",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"current"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2798",children:"packages/extension-api/src/extension-api.d.ts:2798"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2799",children:"packages/extension-api/src/extension-api.d.ts:2799"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{56268:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="Interface: PidsStats",o={id:"interfaces/PidsStats",title:"Interface: PidsStats",description:"Properties",source:"@site/api/interfaces/PidsStats.md",sourceDirName:"interfaces",slug:"/interfaces/PidsStats",permalink:"/api/interfaces/PidsStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"},next:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"current?",id:"current",level:3},{value:"Source",id:"source",level:4},{value:"limit?",id:"limit",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-pidsstats",children:"Interface: PidsStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"current",children:"current?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"current"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2798",children:"packages/extension-api/src/extension-api.d.ts:2798"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2799",children:"packages/extension-api/src/extension-api.d.ts:2799"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/883e2c3c.fe18fe14.js b/assets/js/883e2c3c.fe18fe14.js new file mode 100644 index 00000000000..f3b7b4c2138 --- /dev/null +++ b/assets/js/883e2c3c.fe18fe14.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{4120:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: startPod()",c={id:"namespaces/containerEngine/functions/startPod",title:"Function: startPod()",description:"startPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startPod",permalink:"/api/namespaces/containerEngine/functions/startPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"},next:{title:"statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"startPod"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"podId"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3419",children:"packages/extension-api/src/extension-api.d.ts:3419"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/883e2c3c.fe52b881.js b/assets/js/883e2c3c.fe52b881.js deleted file mode 100644 index 02e737db18b..00000000000 --- a/assets/js/883e2c3c.fe52b881.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{4120:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Function: startPod()",c={id:"namespaces/containerEngine/functions/startPod",title:"Function: startPod()",description:"startPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/startPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/startPod",permalink:"/api/namespaces/containerEngine/functions/startPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"},next:{title:"statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"function-startpod",children:"Function: startPod()"}),"\n",(0,s.jsxs)(e.blockquote,{children:["\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.strong,{children:"startPod"}),"(",(0,s.jsx)(e.code,{children:"engineId"}),", ",(0,s.jsx)(e.code,{children:"podId"}),"): ",(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"engineId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsxs)(e.p,{children:["\u2022 ",(0,s.jsx)(e.strong,{children:"podId"}),": ",(0,s.jsx)(e.code,{children:"string"})]}),"\n",(0,s.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(e.p,{children:[(0,s.jsx)(e.code,{children:"Promise"}),"<",(0,s.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(e.p,{children:(0,s.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3419",children:"packages/extension-api/src/extension-api.d.ts:3419"})})]})}function p(n={}){const{wrapper:e}={...(0,r.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(n){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:i(n.components),s.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a864d1e.43a6edf7.js b/assets/js/8a864d1e.6e435eff.js similarity index 94% rename from assets/js/8a864d1e.43a6edf7.js rename to assets/js/8a864d1e.6e435eff.js index e71c08b2142..76d61f36450 100644 --- a/assets/js/8a864d1e.43a6edf7.js +++ b/assets/js/8a864d1e.6e435eff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{79206:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var o=n(24246),s=n(71670);const i={},r="Type alias: ProviderConnectionStatus",a={id:"type-aliases/ProviderConnectionStatus",title:"Type alias: ProviderConnectionStatus",description:'ProviderConnectionStatus: "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "unknown"',source:"@site/api/type-aliases/ProviderConnectionStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NotificationType",permalink:"/api/type-aliases/NotificationType"},next:{title:"ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"}},c={},d=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-providerconnectionstatus",children:"Type alias: ProviderConnectionStatus"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"ProviderConnectionStatus"}),": ",(0,o.jsx)(t.code,{children:'"started"'})," | ",(0,o.jsx)(t.code,{children:'"stopped"'})," | ",(0,o.jsx)(t.code,{children:'"starting"'})," | ",(0,o.jsx)(t.code,{children:'"stopping"'})," | ",(0,o.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L251",children:"packages/extension-api/src/extension-api.d.ts:251"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var o=n(27378);const s={},i=o.createContext(s);function r(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{79206:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var o=n(24246),s=n(71670);const i={},r="Type alias: ProviderConnectionStatus",a={id:"type-aliases/ProviderConnectionStatus",title:"Type alias: ProviderConnectionStatus",description:'ProviderConnectionStatus: "started" \\| "stopped" \\| "starting" \\| "stopping" \\| "unknown"',source:"@site/api/type-aliases/ProviderConnectionStatus.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NotificationType",permalink:"/api/type-aliases/NotificationType"},next:{title:"ProviderLinks",permalink:"/api/type-aliases/ProviderLinks"}},c={},d=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-providerconnectionstatus",children:"Type alias: ProviderConnectionStatus"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"ProviderConnectionStatus"}),": ",(0,o.jsx)(t.code,{children:'"started"'})," | ",(0,o.jsx)(t.code,{children:'"stopped"'})," | ",(0,o.jsx)(t.code,{children:'"starting"'})," | ",(0,o.jsx)(t.code,{children:'"stopping"'})," | ",(0,o.jsx)(t.code,{children:'"unknown"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L251",children:"packages/extension-api/src/extension-api.d.ts:251"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>r});var o=n(27378);const s={},i=o.createContext(s);function r(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8abd0ba5.aff96286.js b/assets/js/8abd0ba5.18235943.js similarity index 93% rename from assets/js/8abd0ba5.aff96286.js rename to assets/js/8abd0ba5.18235943.js index 82089a37285..da18a555c04 100644 --- a/assets/js/8abd0ba5.aff96286.js +++ b/assets/js/8abd0ba5.18235943.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{68471:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const c={},r="Interface: CustomPickSectionItem",o={id:"interfaces/CustomPickSectionItem",title:"Interface: CustomPickSectionItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickSectionItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"content?",id:"content",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,i.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"content"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1092",children:"packages/extension-api/src/extension-api.d.ts:1092"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markDownContent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1097",children:"packages/extension-api/src/extension-api.d.ts:1097"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1087",children:"packages/extension-api/src/extension-api.d.ts:1087"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{68471:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=t(24246),s=t(71670);const c={},r="Interface: CustomPickSectionItem",o={id:"interfaces/CustomPickSectionItem",title:"Interface: CustomPickSectionItem",description:"Represents an item that can be selected from",source:"@site/api/interfaces/CustomPickSectionItem.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPickSectionItem",permalink:"/api/interfaces/CustomPickSectionItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"},next:{title:"DeviceRequest",permalink:"/api/interfaces/DeviceRequest"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"content?",id:"content",level:3},{value:"Source",id:"source",level:4},{value:"markDownContent?",id:"markdowncontent",level:3},{value:"Source",id:"source-1",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,i.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"content",children:"content?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"content"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1092",children:"packages/extension-api/src/extension-api.d.ts:1092"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markDownContent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1097",children:"packages/extension-api/src/extension-api.d.ts:1097"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1087",children:"packages/extension-api/src/extension-api.d.ts:1087"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var i=t(27378);const s={},c=i.createContext(s);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8b4ba22f.6e3f00f6.js b/assets/js/8b4ba22f.62df16df.js similarity index 94% rename from assets/js/8b4ba22f.6e3f00f6.js rename to assets/js/8b4ba22f.62df16df.js index 875b4c187f9..f7bede14623 100644 --- a/assets/js/8b4ba22f.6e3f00f6.js +++ b/assets/js/8b4ba22f.62df16df.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{10051:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=r(24246),o=r(71670);const s={},i="Interface: CliToolUpdate",c={id:"interfaces/CliToolUpdate",title:"Interface: CliToolUpdate",description:"Properties",source:"@site/api/interfaces/CliToolUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"doUpdate()",id:"doupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clitoolupdate",children:"Interface: CliToolUpdate"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"doupdate",children:"doUpdate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"doUpdate"}),": (",(0,t.jsx)(n.code,{children:"logger"}),") => ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4068",children:"packages/extension-api/src/extension-api.d.ts:4068"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"version"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4067",children:"packages/extension-api/src/extension-api.d.ts:4067"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var t=r(27378);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{10051:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var t=r(24246),o=r(71670);const s={},i="Interface: CliToolUpdate",c={id:"interfaces/CliToolUpdate",title:"Interface: CliToolUpdate",description:"Properties",source:"@site/api/interfaces/CliToolUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/CliToolUpdate",permalink:"/api/interfaces/CliToolUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CliToolOptions",permalink:"/api/interfaces/CliToolOptions"},next:{title:"CliToolUpdateOptions",permalink:"/api/interfaces/CliToolUpdateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"doUpdate()",id:"doupdate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"version",id:"version",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-clitoolupdate",children:"Interface: CliToolUpdate"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"doupdate",children:"doUpdate()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"doUpdate"}),": (",(0,t.jsx)(n.code,{children:"logger"}),") => ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"logger"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,t.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4068",children:"packages/extension-api/src/extension-api.d.ts:4068"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"version"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4067",children:"packages/extension-api/src/extension-api.d.ts:4067"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var t=r(27378);const o={},s=t.createContext(o);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c6c72f9.139d296a.js b/assets/js/8c6c72f9.b9da6a39.js similarity index 94% rename from assets/js/8c6c72f9.139d296a.js rename to assets/js/8c6c72f9.b9da6a39.js index eccb996a333..4e51c7ce100 100644 --- a/assets/js/8c6c72f9.139d296a.js +++ b/assets/js/8c6c72f9.b9da6a39.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{49406:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=n(24246),i=n(71670);const a={},c="Type alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-checkresultlink",children:"Type alias: CheckResultLink"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"CheckResultLink"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(t.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L392",children:"packages/extension-api/src/extension-api.d.ts:392"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{49406:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var s=n(24246),i=n(71670);const a={},c="Type alias: CheckResultLink",o={id:"type-aliases/CheckResultLink",title:"Type alias: CheckResultLink",description:"CheckResultLink: Link",source:"@site/api/type-aliases/CheckResultLink.md",sourceDirName:"type-aliases",slug:"/type-aliases/CheckResultLink",permalink:"/api/type-aliases/CheckResultLink",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent"},next:{title:"CliToolState",permalink:"/api/type-aliases/CliToolState"}},r={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"type-alias-checkresultlink",children:"Type alias: CheckResultLink"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"CheckResultLink"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(t.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L392",children:"packages/extension-api/src/extension-api.d.ts:392"})})]})}function u(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var s=n(27378);const i={},a=s.createContext(i);function c(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c8ef21f.31b9ff74.js b/assets/js/8c8ef21f.4b646b4d.js similarity index 90% rename from assets/js/8c8ef21f.31b9ff74.js rename to assets/js/8c8ef21f.4b646b4d.js index 58466ad1fa3..c2976558fd6 100644 --- a/assets/js/8c8ef21f.31b9ff74.js +++ b/assets/js/8c8ef21f.4b646b4d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{4706:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const r={},c="Interface: Link",o={id:"interfaces/Link",title:"Interface: Link",description:"Properties",source:"@site/api/interfaces/Link.md",sourceDirName:"interfaces",slug:"/interfaces/Link",permalink:"/api/interfaces/Link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"LifecycleContext",permalink:"/api/interfaces/LifecycleContext"},next:{title:"ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"group",children:"group?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"group"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L388",children:"packages/extension-api/src/extension-api.d.ts:388"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L389",children:"packages/extension-api/src/extension-api.d.ts:389"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{4706:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const r={},c="Interface: Link",o={id:"interfaces/Link",title:"Interface: Link",description:"Properties",source:"@site/api/interfaces/Link.md",sourceDirName:"interfaces",slug:"/interfaces/Link",permalink:"/api/interfaces/Link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"LifecycleContext",permalink:"/api/interfaces/LifecycleContext"},next:{title:"ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"group?",id:"group",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4},{value:"url",id:"url",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-link",children:"Interface: Link"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"group",children:"group?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"group"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L388",children:"packages/extension-api/src/extension-api.d.ts:388"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"url",children:"url"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"url"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L389",children:"packages/extension-api/src/extension-api.d.ts:389"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>c});var s=t(27378);const i={},r=s.createContext(i);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8cb0269b.74a37461.js b/assets/js/8cb0269b.b14e842c.js similarity index 92% rename from assets/js/8cb0269b.74a37461.js rename to assets/js/8cb0269b.b14e842c.js index b18db4001b2..d744c5457fd 100644 --- a/assets/js/8cb0269b.74a37461.js +++ b/assets/js/8cb0269b.b14e842c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{50604:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>h,contentTitle:()=>t,default:()=>o,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var r=n(24246),i=n(71670);const c={},t="Class: Uri",d={id:"classes/Uri",title:"Class: Uri",description:"Resource identifier for a resource",source:"@site/api/classes/Uri.md",sourceDirName:"classes",slug:"/classes/Uri",permalink:"/api/classes/Uri",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue"},next:{title:"AuditRecord",permalink:"/api/interfaces/AuditRecord"}},h={},l=[{value:"Constructors",id:"constructors",level:2},{value:"new Uri()",id:"new-uri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Source",id:"source-1",level:4},{value:"fragment",id:"fragment",level:3},{value:"Source",id:"source-2",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"query",id:"query",level:3},{value:"Source",id:"source-5",level:4},{value:"scheme",id:"scheme",level:3},{value:"Source",id:"source-6",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-7",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-8",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-9",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-10",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source-11",level:4}];function a(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"class-uri",children:"Class: Uri"}),"\n",(0,r.jsx)(s.p,{children:"Resource identifier for a resource"}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"new-uri",children:"new Uri()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"private"})," ",(0,r.jsx)(s.strong,{children:"new Uri"}),"(",(0,r.jsx)(s.code,{children:"scheme"}),", ",(0,r.jsx)(s.code,{children:"authority"}),", ",(0,r.jsx)(s.code,{children:"path"}),", ",(0,r.jsx)(s.code,{children:"query"}),", ",(0,r.jsx)(s.code,{children:"fragment"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Use the ",(0,r.jsx)(s.code,{children:"file"})," and ",(0,r.jsx)(s.code,{children:"parse"})," factory functions to create new ",(0,r.jsx)(s.code,{children:"Uri"})," objects."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1331",children:"packages/extension-api/src/extension-api.d.ts:1331"})}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"authority",children:"authority"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Authority is the ",(0,r.jsx)(s.code,{children:"www.example.com"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,r.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1343",children:"packages/extension-api/src/extension-api.d.ts:1343"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fragment",children:"fragment"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Fragment is the ",(0,r.jsx)(s.code,{children:"fragment"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1363",children:"packages/extension-api/src/extension-api.d.ts:1363"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fspath",children:"fsPath"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"fsPath"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,r.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1353",children:"packages/extension-api/src/extension-api.d.ts:1353"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"path",children:"path"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Path is the ",(0,r.jsx)(s.code,{children:"/some/path"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1348",children:"packages/extension-api/src/extension-api.d.ts:1348"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"query",children:"query"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Query is the ",(0,r.jsx)(s.code,{children:"query"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1358",children:"packages/extension-api/src/extension-api.d.ts:1358"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"scheme",children:"scheme"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Scheme is the ",(0,r.jsx)(s.code,{children:"http"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,r.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1337",children:"packages/extension-api/src/extension-api.d.ts:1337"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(s.h3,{id:"tostring",children:"toString()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"toString"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1402",children:"packages/extension-api/src/extension-api.d.ts:1402"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"with",children:"with()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"with"}),"(",(0,r.jsx)(s.code,{children:"change"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Derive a new Uri from this Uri."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"const foo = Uri.parse('http://foo');\nconst httpsFoo = foo.with({ scheme: 'https' });\n// httpsFoo is now 'https://foo'\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change"})]}),"\n",(0,r.jsxs)(s.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,r.jsx)(s.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.authority?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.fragment?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.path?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.query?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.scheme?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsxs)(s.p,{children:["A new Uri that reflects the given change. Will return ",(0,r.jsx)(s.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,r.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1379",children:"packages/extension-api/src/extension-api.d.ts:1379"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"file",children:"file()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"file"}),"(",(0,r.jsx)(s.code,{children:"path"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a file system path. The ",(0,r.jsx)(s.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,r.jsx)(s.code,{children:"file"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1316",children:"packages/extension-api/src/extension-api.d.ts:1316"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"joinPath"}),"(",(0,r.jsx)(s.code,{children:"base"}),", ...",(0,r.jsx)(s.code,{children:"pathSegments"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base"}),": ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,r.jsx)(s.p,{children:"An uri. Must have a path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"pathSegments"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"One more more path fragments"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,r.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1326",children:"packages/extension-api/src/extension-api.d.ts:1326"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"parse",children:"parse()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"parse"}),"(",(0,r.jsx)(s.code,{children:"value"}),", ",(0,r.jsx)(s.code,{children:"strict"}),"?): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a string, e.g. ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path"}),",\n",(0,r.jsx)(s.code,{children:"file:///usr/home"}),", or ",(0,r.jsx)(s.code,{children:"scheme:with/path"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.em,{children:"Note"})," that for a while uris without a ",(0,r.jsx)(s.code,{children:"scheme"})," were accepted. That is not correct\nas all uris should have a scheme. To avoid breakage of existing code the optional\n",(0,r.jsx)(s.code,{children:"strict"}),"-argument has been added. We ",(0,r.jsx)(s.em,{children:"strongly"})," advise to use it, e.g. ",(0,r.jsx)(s.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"value"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The string value of an Uri."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"strict?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["Throw an error when ",(0,r.jsx)(s.code,{children:"value"})," is empty or when no ",(0,r.jsx)(s.code,{children:"scheme"})," can be parsed."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new Uri instance."}),"\n",(0,r.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,r.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1310",children:"packages/extension-api/src/extension-api.d.ts:1310"})})]})}function o(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>t});var r=n(27378);const i={},c=r.createContext(i);function t(e){const s=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{50604:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>h,contentTitle:()=>t,default:()=>a,frontMatter:()=>c,metadata:()=>d,toc:()=>l});var r=n(24246),i=n(71670);const c={},t="Class: Uri",d={id:"classes/Uri",title:"Class: Uri",description:"Resource identifier for a resource",source:"@site/api/classes/Uri.md",sourceDirName:"classes",slug:"/classes/Uri",permalink:"/api/classes/Uri",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue"},next:{title:"AuditRecord",permalink:"/api/interfaces/AuditRecord"}},h={},l=[{value:"Constructors",id:"constructors",level:2},{value:"new Uri()",id:"new-uri",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"authority",id:"authority",level:3},{value:"Source",id:"source-1",level:4},{value:"fragment",id:"fragment",level:3},{value:"Source",id:"source-2",level:4},{value:"fsPath",id:"fspath",level:3},{value:"Source",id:"source-3",level:4},{value:"path",id:"path",level:3},{value:"Source",id:"source-4",level:4},{value:"query",id:"query",level:3},{value:"Source",id:"source-5",level:4},{value:"scheme",id:"scheme",level:3},{value:"Source",id:"source-6",level:4},{value:"Methods",id:"methods",level:2},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-7",level:4},{value:"with()",id:"with",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-8",level:4},{value:"file()",id:"file",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-9",level:4},{value:"joinPath()",id:"joinpath",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-10",level:4},{value:"parse()",id:"parse",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-5",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source-11",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.h1,{id:"class-uri",children:"Class: Uri"}),"\n",(0,r.jsx)(s.p,{children:"Resource identifier for a resource"}),"\n",(0,r.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,r.jsx)(s.h3,{id:"new-uri",children:"new Uri()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"private"})," ",(0,r.jsx)(s.strong,{children:"new Uri"}),"(",(0,r.jsx)(s.code,{children:"scheme"}),", ",(0,r.jsx)(s.code,{children:"authority"}),", ",(0,r.jsx)(s.code,{children:"path"}),", ",(0,r.jsx)(s.code,{children:"query"}),", ",(0,r.jsx)(s.code,{children:"fragment"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Use the ",(0,r.jsx)(s.code,{children:"file"})," and ",(0,r.jsx)(s.code,{children:"parse"})," factory functions to create new ",(0,r.jsx)(s.code,{children:"Uri"})," objects."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1331",children:"packages/extension-api/src/extension-api.d.ts:1331"})}),"\n",(0,r.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(s.h3,{id:"authority",children:"authority"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"authority"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Authority is the ",(0,r.jsx)(s.code,{children:"www.example.com"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part between the first double slashes and the next slash."]}),"\n",(0,r.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1343",children:"packages/extension-api/src/extension-api.d.ts:1343"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fragment",children:"fragment"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"fragment"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Fragment is the ",(0,r.jsx)(s.code,{children:"fragment"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1363",children:"packages/extension-api/src/extension-api.d.ts:1363"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"fspath",children:"fsPath"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"fsPath"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The string representing the corresponding file system path of this Uri."}),"\n",(0,r.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1353",children:"packages/extension-api/src/extension-api.d.ts:1353"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"path",children:"path"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Path is the ",(0,r.jsx)(s.code,{children:"/some/path"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1348",children:"packages/extension-api/src/extension-api.d.ts:1348"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"query",children:"query"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"query"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Query is the ",(0,r.jsx)(s.code,{children:"query"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1358",children:"packages/extension-api/src/extension-api.d.ts:1358"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"scheme",children:"scheme"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"readonly"})," ",(0,r.jsx)(s.strong,{children:"scheme"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Scheme is the ",(0,r.jsx)(s.code,{children:"http"})," part of ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path?query#fragment"}),".\nThe part before the first colon."]}),"\n",(0,r.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1337",children:"packages/extension-api/src/extension-api.d.ts:1337"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(s.h3,{id:"tostring",children:"toString()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"toString"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1402",children:"packages/extension-api/src/extension-api.d.ts:1402"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"with",children:"with()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"with"}),"(",(0,r.jsx)(s.code,{children:"change"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Derive a new Uri from this Uri."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"const foo = Uri.parse('http://foo');\nconst httpsFoo = foo.with({ scheme: 'https' });\n// httpsFoo is now 'https://foo'\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change"})]}),"\n",(0,r.jsxs)(s.p,{children:["An object that describes a change to this Uri. To unset components use ",(0,r.jsx)(s.code,{children:"undefined"})," or\nthe empty string."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.authority?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new authority, defaults to this Uri's authority."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.fragment?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new fragment, defaults to this Uri's fragment."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.path?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new path, defaults to this Uri's path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.query?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new query, defaults to this Uri's query."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"change.scheme?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The new scheme, defaults to this Uri's scheme."}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsxs)(s.p,{children:["A new Uri that reflects the given change. Will return ",(0,r.jsx)(s.code,{children:"this"})," Uri if the change\nis not changing anything."]}),"\n",(0,r.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1379",children:"packages/extension-api/src/extension-api.d.ts:1379"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"file",children:"file()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"file"}),"(",(0,r.jsx)(s.code,{children:"path"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a file system path. The ",(0,r.jsx)(s.a,{href:"/api/classes/Uri#scheme",children:"scheme"}),"\nwill be ",(0,r.jsx)(s.code,{children:"file"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"path"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1316",children:"packages/extension-api/src/extension-api.d.ts:1316"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinpath",children:"joinPath()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"joinPath"}),"(",(0,r.jsx)(s.code,{children:"base"}),", ...",(0,r.jsx)(s.code,{children:"pathSegments"}),"): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a new uri which path is the result of joining\nthe path of the base uri with the provided path segments."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base"}),": ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n",(0,r.jsx)(s.p,{children:"An uri. Must have a path."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ...",(0,r.jsx)(s.strong,{children:"pathSegments"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"One more more path fragments"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new uri which path is joined with the given fragments"}),"\n",(0,r.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1326",children:"packages/extension-api/src/extension-api.d.ts:1326"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"parse",children:"parse()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"static"})," ",(0,r.jsx)(s.strong,{children:"parse"}),"(",(0,r.jsx)(s.code,{children:"value"}),", ",(0,r.jsx)(s.code,{children:"strict"}),"?): ",(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Create an URI from a string, e.g. ",(0,r.jsx)(s.code,{children:"http://www.example.com/some/path"}),",\n",(0,r.jsx)(s.code,{children:"file:///usr/home"}),", or ",(0,r.jsx)(s.code,{children:"scheme:with/path"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.em,{children:"Note"})," that for a while uris without a ",(0,r.jsx)(s.code,{children:"scheme"})," were accepted. That is not correct\nas all uris should have a scheme. To avoid breakage of existing code the optional\n",(0,r.jsx)(s.code,{children:"strict"}),"-argument has been added. We ",(0,r.jsx)(s.em,{children:"strongly"})," advise to use it, e.g. ",(0,r.jsx)(s.code,{children:"Uri.parse('my:uri', true)"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"value"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The string value of an Uri."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"strict?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["Throw an error when ",(0,r.jsx)(s.code,{children:"value"})," is empty or when no ",(0,r.jsx)(s.code,{children:"scheme"})," can be parsed."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri",children:(0,r.jsx)(s.code,{children:"Uri"})})}),"\n",(0,r.jsx)(s.p,{children:"A new Uri instance."}),"\n",(0,r.jsx)(s.h4,{id:"see",children:"See"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/api/classes/Uri#tostring",children:"Uri.toString"})}),"\n",(0,r.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1310",children:"packages/extension-api/src/extension-api.d.ts:1310"})})]})}function a(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>d,a:()=>t});var r=n(27378);const i={},c=r.createContext(i);function t(e){const s=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8ccdb99f.ab189fcd.js b/assets/js/8ccdb99f.bcd68439.js similarity index 80% rename from assets/js/8ccdb99f.ab189fcd.js rename to assets/js/8ccdb99f.bcd68439.js index d5869cb2114..c0394b26aba 100644 --- a/assets/js/8ccdb99f.ab189fcd.js +++ b/assets/js/8ccdb99f.bcd68439.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{70593:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const i={},c="Type alias: MountConsistency",a={id:"type-aliases/MountConsistency",title:"Type alias: MountConsistency",description:'MountConsistency: "default" \\| "consistent" \\| "cached" \\| "delegated"',source:"@site/api/type-aliases/MountConsistency.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConsistency",permalink:"/api/type-aliases/MountConsistency",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"},next:{title:"MountPropagation",permalink:"/api/type-aliases/MountPropagation"}},r={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{70593:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const c={},i="Type alias: MountConsistency",a={id:"type-aliases/MountConsistency",title:"Type alias: MountConsistency",description:'MountConsistency: "default" \\| "consistent" \\| "cached" \\| "delegated"',source:"@site/api/type-aliases/MountConsistency.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConsistency",permalink:"/api/type-aliases/MountConsistency",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountConfig",permalink:"/api/type-aliases/MountConfig"},next:{title:"MountPropagation",permalink:"/api/type-aliases/MountPropagation"}},r={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-mountconsistency",children:"Type alias: MountConsistency"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"MountConsistency"}),": ",(0,s.jsx)(n.code,{children:'"default"'})," | ",(0,s.jsx)(n.code,{children:'"consistent"'})," | ",(0,s.jsx)(n.code,{children:'"cached"'})," | ",(0,s.jsx)(n.code,{children:'"delegated"'})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2129",children:"packages/extension-api/src/extension-api.d.ts:2129"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const o={},c=s.createContext(o);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8dbb6800.34249012.js b/assets/js/8dbb6800.a99cf824.js similarity index 95% rename from assets/js/8dbb6800.34249012.js rename to assets/js/8dbb6800.a99cf824.js index 26737de5105..3fbfdd15759 100644 --- a/assets/js/8dbb6800.34249012.js +++ b/assets/js/8dbb6800.a99cf824.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{71773:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),o=s(71670);const i={},c="Function: listVolumes()",r={id:"namespaces/containerEngine/functions/listVolumes",title:"Function: listVolumes()",description:"listVolumes(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listVolumes.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listPods",permalink:"/api/namespaces/containerEngine/functions/listPods"},next:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listvolumes",children:"Function: listVolumes()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listVolumes"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3409",children:"packages/extension-api/src/extension-api.d.ts:3409"})})]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{71773:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var t=s(24246),o=s(71670);const i={},c="Function: listVolumes()",r={id:"namespaces/containerEngine/functions/listVolumes",title:"Function: listVolumes()",description:"listVolumes(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listVolumes.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listVolumes",permalink:"/api/namespaces/containerEngine/functions/listVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listPods",permalink:"/api/namespaces/containerEngine/functions/listPods"},next:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-listvolumes",children:"Function: listVolumes()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"listVolumes"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/VolumeListInfo",children:(0,t.jsx)(n.code,{children:"VolumeListInfo"})}),"[]>"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3409",children:"packages/extension-api/src/extension-api.d.ts:3409"})})]})}function d(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8eeedb31.6ad612e8.js b/assets/js/8eeedb31.f1f917bf.js similarity index 97% rename from assets/js/8eeedb31.6ad612e8.js rename to assets/js/8eeedb31.f1f917bf.js index c8a3d26c173..2a10fdab7c2 100644 --- a/assets/js/8eeedb31.6ad612e8.js +++ b/assets/js/8eeedb31.f1f917bf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{50174:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1618",children:"packages/extension-api/src/extension-api.d.ts:1618"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{50174:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var i=t(24246),a=t(71670);const s={},r="Interface: WebviewPanelOnDidChangeViewStateEvent",c={id:"interfaces/WebviewPanelOnDidChangeViewStateEvent",title:"Interface: WebviewPanelOnDidChangeViewStateEvent",description:"Event fired when a webview panel's view state changes.",source:"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewPanelOnDidChangeViewStateEvent",permalink:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"},next:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"webviewPanel",id:"webviewpanel",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-webviewpanelondidchangeviewstateevent",children:"Interface: WebviewPanelOnDidChangeViewStateEvent"}),"\n",(0,i.jsx)(n.p,{children:"Event fired when a webview panel's view state changes."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"webviewpanel",children:"webviewPanel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"webviewPanel"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Webview panel whose view state changed."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1618",children:"packages/extension-api/src/extension-api.d.ts:1618"})})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var i=t(27378);const a={},s=i.createContext(a);function r(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/905702d2.15384b6d.js b/assets/js/905702d2.9270b0a4.js similarity index 95% rename from assets/js/905702d2.15384b6d.js rename to assets/js/905702d2.9270b0a4.js index 34ac8b8294c..8773335a9e5 100644 --- a/assets/js/905702d2.15384b6d.js +++ b/assets/js/905702d2.9270b0a4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{85316:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"},next:{title:"registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L678",children:"packages/extension-api/src/extension-api.d.ts:678"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{85316:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var s=t(24246),r=t(71670);const i={},a="Function: registerMenuItem()",c={id:"namespaces/tray/functions/registerMenuItem",title:"Function: registerMenuItem()",description:"registerMenuItem(item): Disposable",source:"@site/api/namespaces/tray/functions/registerMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: tray",permalink:"/api/namespaces/tray/"},next:{title:"registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registermenuitem",children:"Function: registerMenuItem()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerMenuItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Creates a menu not related to a Provider"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})})]}),"\n",(0,s.jsx)(n.p,{children:"the item to add in the tray menu"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L678",children:"packages/extension-api/src/extension-api.d.ts:678"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(27378);const r={},i=s.createContext(r);function a(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91008145.4aeade7a.js b/assets/js/91008145.6688c780.js similarity index 78% rename from assets/js/91008145.4aeade7a.js rename to assets/js/91008145.6688c780.js index 10a1135910e..34650ca1bec 100644 --- a/assets/js/91008145.4aeade7a.js +++ b/assets/js/91008145.6688c780.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{90927:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=t(24246),o=t(71670);const i={},r="Function: listNetworks()",c={id:"namespaces/containerEngine/functions/listNetworks",title:"Function: listNetworks()",description:"listNetworks(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listNetworks.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"},next:{title:"listPods",permalink:"/api/namespaces/containerEngine/functions/listPods"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-listnetworks",children:"Function: listNetworks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listNetworks"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3403",children:"packages/extension-api/src/extension-api.d.ts:3403"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var s=t(27378);const o={},i=s.createContext(o);function r(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{90927:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var s=t(24246),o=t(71670);const i={},c="Function: listNetworks()",r={id:"namespaces/containerEngine/functions/listNetworks",title:"Function: listNetworks()",description:"listNetworks(): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listNetworks.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos"},next:{title:"listPods",permalink:"/api/namespaces/containerEngine/functions/listPods"}},a={},l=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-listnetworks",children:"Function: listNetworks()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"listNetworks"}),"(): ",(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"})," <",(0,s.jsx)(n.a,{href:"/api/interfaces/NetworkInspectInfo",children:(0,s.jsx)(n.code,{children:"NetworkInspectInfo"})}),"[]>"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3403",children:"packages/extension-api/src/extension-api.d.ts:3403"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>c});var s=t(27378);const o={},i=s.createContext(o);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91392348.ccd004ca.js b/assets/js/91392348.58eb5c18.js similarity index 94% rename from assets/js/91392348.ccd004ca.js rename to assets/js/91392348.58eb5c18.js index def4522d23d..7cf4e2934d2 100644 --- a/assets/js/91392348.ccd004ca.js +++ b/assets/js/91392348.58eb5c18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{11495:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterKubernetesConnectionEvent",c={id:"interfaces/UnregisterKubernetesConnectionEvent",title:"Interface: UnregisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"},next:{title:"UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{11495:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const o={},s="Interface: UnregisterKubernetesConnectionEvent",c={id:"interfaces/UnregisterKubernetesConnectionEvent",title:"Interface: UnregisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"},next:{title:"UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-unregisterkubernetesconnectionevent",children:"Interface: UnregisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},o=r.createContext(i);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/91fe1403.8c36af0c.js b/assets/js/91fe1403.f0d4cd64.js similarity index 74% rename from assets/js/91fe1403.8c36af0c.js rename to assets/js/91fe1403.f0d4cd64.js index a5702f606c1..1cae00fc59c 100644 --- a/assets/js/91fe1403.8c36af0c.js +++ b/assets/js/91fe1403.f0d4cd64.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{78154:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var s=a(24246),r=a(71670);const i={},t="Variable: clipboard",c={id:"namespaces/env/variables/clipboard",title:"Variable: clipboard",description:"const clipboard: Clipboard",source:"@site/api/namespaces/env/variables/clipboard.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/clipboard",permalink:"/api/namespaces/env/variables/clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: env",permalink:"/api/namespaces/env/"},next:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"const"})," ",(0,s.jsx)(n.strong,{children:"clipboard"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,s.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3757",children:"packages/extension-api/src/extension-api.d.ts:3757"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>c,a:()=>t});var s=a(27378);const r={},i=s.createContext(r);function t(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{78154:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var s=a(24246),r=a(71670);const c={},i="Variable: clipboard",t={id:"namespaces/env/variables/clipboard",title:"Variable: clipboard",description:"const clipboard: Clipboard",source:"@site/api/namespaces/env/variables/clipboard.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/clipboard",permalink:"/api/namespaces/env/variables/clipboard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: env",permalink:"/api/namespaces/env/"},next:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"variable-clipboard",children:"Variable: clipboard"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"const"})," ",(0,s.jsx)(n.strong,{children:"clipboard"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Clipboard",children:(0,s.jsx)(n.code,{children:"Clipboard"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The system clipboard."}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3757",children:"packages/extension-api/src/extension-api.d.ts:3757"})})]})}function d(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,a)=>{a.d(n,{Z:()=>t,a:()=>i});var s=a(27378);const r={},c=s.createContext(r);function i(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/920c2ac2.846df7a5.js b/assets/js/920c2ac2.522a5ee0.js similarity index 94% rename from assets/js/920c2ac2.846df7a5.js rename to assets/js/920c2ac2.522a5ee0.js index ed10f88725d..1bd34529b80 100644 --- a/assets/js/920c2ac2.846df7a5.js +++ b/assets/js/920c2ac2.522a5ee0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{64075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>o});var s=i(24246),l=i(71670);const t={},c="Interface: MemoryStats",r={id:"interfaces/MemoryStats",title:"Interface: MemoryStats",description:"Properties",source:"@site/api/interfaces/MemoryStats.md",sourceDirName:"interfaces",slug:"/interfaces/MemoryStats",permalink:"/api/interfaces/MemoryStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},next:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Source",id:"source",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Source",id:"source-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Source",id:"source-2",level:4},{value:"limit",id:"limit",level:3},{value:"Source",id:"source-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Source",id:"source-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Source",id:"source-5",level:4},{value:"stats",id:"stats",level:3},{value:"active_anon",id:"active_anon",level:4},{value:"active_file",id:"active_file",level:4},{value:"cache",id:"cache",level:4},{value:"hierarchical_memory_limit",id:"hierarchical_memory_limit",level:4},{value:"inactive_anon",id:"inactive_anon",level:4},{value:"inactive_file",id:"inactive_file",level:4},{value:"mapped_file",id:"mapped_file",level:4},{value:"pgfault",id:"pgfault",level:4},{value:"pgmajfault",id:"pgmajfault",level:4},{value:"pgpgin",id:"pgpgin",level:4},{value:"pgpgout",id:"pgpgout",level:4},{value:"rss",id:"rss",level:4},{value:"rss_huge",id:"rss_huge",level:4},{value:"total_active_anon",id:"total_active_anon",level:4},{value:"total_active_file",id:"total_active_file",level:4},{value:"total_cache",id:"total_cache",level:4},{value:"total_inactive_anon",id:"total_inactive_anon",level:4},{value:"total_inactive_file",id:"total_inactive_file",level:4},{value:"total_mapped_file",id:"total_mapped_file",level:4},{value:"total_pgfault",id:"total_pgfault",level:4},{value:"total_pgmajfault",id:"total_pgmajfault",level:4},{value:"total_pgpgin",id:"total_pgpgin",level:4},{value:"total_pgpgout",id:"total_pgpgout",level:4},{value:"total_rss",id:"total_rss",level:4},{value:"total_rss_huge",id:"total_rss_huge",level:4},{value:"total_unevictable",id:"total_unevictable",level:4},{value:"total_writeback",id:"total_writeback",level:4},{value:"unevictable",id:"unevictable",level:4},{value:"writeback",id:"writeback",level:4},{value:"Source",id:"source-6",level:4},{value:"usage",id:"usage",level:3},{value:"Source",id:"source-7",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2881",children:"packages/extension-api/src/extension-api.d.ts:2881"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commitpeakbytes",children:"commitpeakbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitpeakbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2882",children:"packages/extension-api/src/extension-api.d.ts:2882"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"failcnt",children:"failcnt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"failcnt"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2877",children:"packages/extension-api/src/extension-api.d.ts:2877"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2878",children:"packages/extension-api/src/extension-api.d.ts:2878"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"max_usage",children:"max_usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"max_usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2875",children:"packages/extension-api/src/extension-api.d.ts:2875"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"privateworkingset",children:"privateworkingset?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"privateworkingset"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2883",children:"packages/extension-api/src/extension-api.d.ts:2883"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stats",children:"stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stats"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_anon",children:"active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_file",children:"active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cache",children:"cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hierarchical_memory_limit",children:"hierarchical_memory_limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hierarchical_memory_limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_anon",children:"inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_file",children:"inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mapped_file",children:"mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgfault",children:"pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgmajfault",children:"pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgin",children:"pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgout",children:"pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss",children:"rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss_huge",children:"rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_anon",children:"total_active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_file",children:"total_active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_cache",children:"total_cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_anon",children:"total_inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_file",children:"total_inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_mapped_file",children:"total_mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgfault",children:"total_pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgmajfault",children:"total_pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgin",children:"total_pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgout",children:"total_pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss",children:"total_rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss_huge",children:"total_rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_unevictable",children:"total_unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_writeback",children:"total_writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"unevictable",children:"unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"writeback",children:"writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2844",children:"packages/extension-api/src/extension-api.d.ts:2844"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usage",children:"usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{64075:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var s=i(24246),l=i(71670);const t={},c="Interface: MemoryStats",r={id:"interfaces/MemoryStats",title:"Interface: MemoryStats",description:"Properties",source:"@site/api/interfaces/MemoryStats.md",sourceDirName:"interfaces",slug:"/interfaces/MemoryStats",permalink:"/api/interfaces/MemoryStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo"},next:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"commitbytes?",id:"commitbytes",level:3},{value:"Source",id:"source",level:4},{value:"commitpeakbytes?",id:"commitpeakbytes",level:3},{value:"Source",id:"source-1",level:4},{value:"failcnt",id:"failcnt",level:3},{value:"Source",id:"source-2",level:4},{value:"limit",id:"limit",level:3},{value:"Source",id:"source-3",level:4},{value:"max_usage",id:"max_usage",level:3},{value:"Source",id:"source-4",level:4},{value:"privateworkingset?",id:"privateworkingset",level:3},{value:"Source",id:"source-5",level:4},{value:"stats",id:"stats",level:3},{value:"active_anon",id:"active_anon",level:4},{value:"active_file",id:"active_file",level:4},{value:"cache",id:"cache",level:4},{value:"hierarchical_memory_limit",id:"hierarchical_memory_limit",level:4},{value:"inactive_anon",id:"inactive_anon",level:4},{value:"inactive_file",id:"inactive_file",level:4},{value:"mapped_file",id:"mapped_file",level:4},{value:"pgfault",id:"pgfault",level:4},{value:"pgmajfault",id:"pgmajfault",level:4},{value:"pgpgin",id:"pgpgin",level:4},{value:"pgpgout",id:"pgpgout",level:4},{value:"rss",id:"rss",level:4},{value:"rss_huge",id:"rss_huge",level:4},{value:"total_active_anon",id:"total_active_anon",level:4},{value:"total_active_file",id:"total_active_file",level:4},{value:"total_cache",id:"total_cache",level:4},{value:"total_inactive_anon",id:"total_inactive_anon",level:4},{value:"total_inactive_file",id:"total_inactive_file",level:4},{value:"total_mapped_file",id:"total_mapped_file",level:4},{value:"total_pgfault",id:"total_pgfault",level:4},{value:"total_pgmajfault",id:"total_pgmajfault",level:4},{value:"total_pgpgin",id:"total_pgpgin",level:4},{value:"total_pgpgout",id:"total_pgpgout",level:4},{value:"total_rss",id:"total_rss",level:4},{value:"total_rss_huge",id:"total_rss_huge",level:4},{value:"total_unevictable",id:"total_unevictable",level:4},{value:"total_writeback",id:"total_writeback",level:4},{value:"unevictable",id:"unevictable",level:4},{value:"writeback",id:"writeback",level:4},{value:"Source",id:"source-6",level:4},{value:"usage",id:"usage",level:3},{value:"Source",id:"source-7",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-memorystats",children:"Interface: MemoryStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"commitbytes",children:"commitbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2881",children:"packages/extension-api/src/extension-api.d.ts:2881"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commitpeakbytes",children:"commitpeakbytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"commitpeakbytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2882",children:"packages/extension-api/src/extension-api.d.ts:2882"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"failcnt",children:"failcnt"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"failcnt"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2877",children:"packages/extension-api/src/extension-api.d.ts:2877"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"limit",children:"limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2878",children:"packages/extension-api/src/extension-api.d.ts:2878"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"max_usage",children:"max_usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"max_usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2875",children:"packages/extension-api/src/extension-api.d.ts:2875"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"privateworkingset",children:"privateworkingset?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"privateworkingset"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2883",children:"packages/extension-api/src/extension-api.d.ts:2883"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stats",children:"stats"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"stats"}),": ",(0,s.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_anon",children:"active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"active_file",children:"active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"cache",children:"cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"hierarchical_memory_limit",children:"hierarchical_memory_limit"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"hierarchical_memory_limit"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_anon",children:"inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"inactive_file",children:"inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"mapped_file",children:"mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgfault",children:"pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgmajfault",children:"pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgin",children:"pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"pgpgout",children:"pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss",children:"rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"rss_huge",children:"rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_anon",children:"total_active_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_active_file",children:"total_active_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_active_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_cache",children:"total_cache"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_cache"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_anon",children:"total_inactive_anon"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_anon"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_inactive_file",children:"total_inactive_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_inactive_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_mapped_file",children:"total_mapped_file"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_mapped_file"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgfault",children:"total_pgfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgmajfault",children:"total_pgmajfault"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgmajfault"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgin",children:"total_pgpgin"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgin"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_pgpgout",children:"total_pgpgout"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_pgpgout"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss",children:"total_rss"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_rss_huge",children:"total_rss_huge"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_rss_huge"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_unevictable",children:"total_unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"total_writeback",children:"total_writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"total_writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"unevictable",children:"unevictable"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"unevictable"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"writeback",children:"writeback"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"writeback"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2844",children:"packages/extension-api/src/extension-api.d.ts:2844"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usage",children:"usage"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"usage"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2876",children:"packages/extension-api/src/extension-api.d.ts:2876"})})]})}function h(e={}){const{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var s=i(27378);const l={},t=s.createContext(l);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/927c84a6.e0d10218.js b/assets/js/927c84a6.890d74f9.js similarity index 84% rename from assets/js/927c84a6.e0d10218.js rename to assets/js/927c84a6.890d74f9.js index 979c30944d4..be8df176b99 100644 --- a/assets/js/927c84a6.e0d10218.js +++ b/assets/js/927c84a6.890d74f9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{45518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const c={},r="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"CliTool",permalink:"/api/interfaces/CliTool"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L395",children:"packages/extension-api/src/extension-api.d.ts:395"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L396",children:"packages/extension-api/src/extension-api.d.ts:396"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{45518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var s=t(24246),i=t(71670);const c={},r="Interface: CheckResultFixCommand",o={id:"interfaces/CheckResultFixCommand",title:"Interface: CheckResultFixCommand",description:"Properties",source:"@site/api/interfaces/CheckResultFixCommand.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"},next:{title:"CliTool",permalink:"/api/interfaces/CliTool"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"title",id:"title",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-checkresultfixcommand",children:"Interface: CheckResultFixCommand"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L395",children:"packages/extension-api/src/extension-api.d.ts:395"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L396",children:"packages/extension-api/src/extension-api.d.ts:396"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>r});var s=t(27378);const i={},c=s.createContext(i);function r(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9286a297.0bd6a47a.js b/assets/js/9286a297.6a29fab3.js similarity index 86% rename from assets/js/9286a297.0bd6a47a.js rename to assets/js/9286a297.6a29fab3.js index d82a17eac5b..48d9fc848eb 100644 --- a/assets/js/9286a297.0bd6a47a.js +++ b/assets/js/9286a297.6a29fab3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{19539:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var o=i(24246),t=i(71670);const a={},r="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,o.jsx)(e.code,{children:"connection"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"connection"}),": ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4230",children:"packages/extension-api/src/extension-api.d.ts:4230"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>r});var o=i(27378);const t={},a=o.createContext(t);function r(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:r(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{19539:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>s,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=i(24246),t=i(71670);const r={},a="Function: navigateToEditProviderContainerConnection()",c={id:"namespaces/navigation/functions/navigateToEditProviderContainerConnection",title:"Function: navigateToEditProviderContainerConnection()",description:"navigateToEditProviderContainerConnection(connection): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToEditProviderContainerConnection",permalink:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContribution",permalink:"/api/namespaces/navigation/functions/navigateToContribution"},next:{title:"navigateToImage",permalink:"/api/namespaces/navigation/functions/navigateToImage"}},s={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetoeditprovidercontainerconnection",children:"Function: navigateToEditProviderContainerConnection()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToEditProviderContainerConnection"}),"(",(0,o.jsx)(e.code,{children:"connection"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.p,{children:"Navigate to the Edit Provider Container Connection page"}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"connection"}),": ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4230",children:"packages/extension-api/src/extension-api.d.ts:4230"})})]})}function l(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>a});var o=i(27378);const t={},r=o.createContext(t);function a(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:a(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/92b08985.79e943c4.js b/assets/js/92b08985.05e88115.js similarity index 88% rename from assets/js/92b08985.79e943c4.js rename to assets/js/92b08985.05e88115.js index c3f45fb2de6..94821c76ddc 100644 --- a/assets/js/92b08985.79e943c4.js +++ b/assets/js/92b08985.05e88115.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{60379:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: NetworkContainer",o={id:"interfaces/NetworkContainer",title:"Interface: NetworkContainer",description:"Properties",source:"@site/api/interfaces/NetworkContainer.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkContainer",permalink:"/api/interfaces/NetworkContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountSettings",permalink:"/api/interfaces/MountSettings"},next:{title:"NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Source",id:"source-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Source",id:"source-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EndpointID"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1990",children:"packages/extension-api/src/extension-api.d.ts:1990"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MacAddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1991",children:"packages/extension-api/src/extension-api.d.ts:1991"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1989",children:"packages/extension-api/src/extension-api.d.ts:1989"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{60379:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const t={},c="Interface: NetworkContainer",o={id:"interfaces/NetworkContainer",title:"Interface: NetworkContainer",description:"Properties",source:"@site/api/interfaces/NetworkContainer.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkContainer",permalink:"/api/interfaces/NetworkContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountSettings",permalink:"/api/interfaces/MountSettings"},next:{title:"NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"EndpointID",id:"endpointid",level:3},{value:"Source",id:"source",level:4},{value:"IPv4Address",id:"ipv4address",level:3},{value:"Source",id:"source-1",level:4},{value:"IPv6Address",id:"ipv6address",level:3},{value:"Source",id:"source-2",level:4},{value:"MacAddress",id:"macaddress",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-networkcontainer",children:"Interface: NetworkContainer"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"EndpointID"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1990",children:"packages/extension-api/src/extension-api.d.ts:1990"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv4address",children:"IPv4Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv4Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ipv6address",children:"IPv6Address"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"IPv6Address"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"MacAddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1991",children:"packages/extension-api/src/extension-api.d.ts:1991"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1989",children:"packages/extension-api/src/extension-api.d.ts:1989"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/92d7df62.371dd8c4.js b/assets/js/92d7df62.f2c2a891.js similarity index 95% rename from assets/js/92d7df62.371dd8c4.js rename to assets/js/92d7df62.f2c2a891.js index 86a74a77d4a..120d4d7b642 100644 --- a/assets/js/92d7df62.371dd8c4.js +++ b/assets/js/92d7df62.f2c2a891.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{69313:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(24246),i=n(71670);const r={},c="Interface: Auditor",d={id:"interfaces/Auditor",title:"Interface: Auditor",description:"Methods",source:"@site/api/interfaces/Auditor.md",sourceDirName:"interfaces",slug:"/interfaces/Auditor",permalink:"/api/interfaces/Auditor",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuditResult",permalink:"/api/interfaces/AuditResult"},next:{title:"AuthConfig",permalink:"/api/interfaces/AuthConfig"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"auditItems()",id:"audititems",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"}),"\n",(0,s.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"auditItems"}),"(",(0,s.jsx)(t.code,{children:"items"}),"): ",(0,s.jsx)(t.code,{children:"Promise"})," <",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"items"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,s.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Promise"})," <",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L384",children:"packages/extension-api/src/extension-api.d.ts:384"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>d,a:()=>c});var s=n(27378);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{69313:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var s=n(24246),i=n(71670);const r={},c="Interface: Auditor",d={id:"interfaces/Auditor",title:"Interface: Auditor",description:"Methods",source:"@site/api/interfaces/Auditor.md",sourceDirName:"interfaces",slug:"/interfaces/Auditor",permalink:"/api/interfaces/Auditor",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuditResult",permalink:"/api/interfaces/AuditResult"},next:{title:"AuthConfig",permalink:"/api/interfaces/AuthConfig"}},o={},a=[{value:"Methods",id:"methods",level:2},{value:"auditItems()",id:"audititems",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"interface-auditor",children:"Interface: Auditor"}),"\n",(0,s.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(t.h3,{id:"audititems",children:"auditItems()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"auditItems"}),"(",(0,s.jsx)(t.code,{children:"items"}),"): ",(0,s.jsx)(t.code,{children:"Promise"})," <",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"items"}),": ",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditRequestItems",children:(0,s.jsx)(t.code,{children:"AuditRequestItems"})})]}),"\n",(0,s.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"Promise"})," <",(0,s.jsx)(t.a,{href:"/api/interfaces/AuditResult",children:(0,s.jsx)(t.code,{children:"AuditResult"})}),">"]}),"\n",(0,s.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L384",children:"packages/extension-api/src/extension-api.d.ts:384"})})]})}function l(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>d,a:()=>c});var s=n(27378);const i={},r=s.createContext(i);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/931e3b0a.1ad3183b.js b/assets/js/931e3b0a.654442b9.js similarity index 91% rename from assets/js/931e3b0a.1ad3183b.js rename to assets/js/931e3b0a.654442b9.js index 2f92edfdb1d..434e4e7a713 100644 --- a/assets/js/931e3b0a.1ad3183b.js +++ b/assets/js/931e3b0a.654442b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{33505:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: PortBinding",c={id:"interfaces/PortBinding",title:"Interface: PortBinding",description:"Properties",source:"@site/api/interfaces/PortBinding.md",sourceDirName:"interfaces",slug:"/interfaces/PortBinding",permalink:"/api/interfaces/PortBinding",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Port",permalink:"/api/interfaces/Port"},next:{title:"PortMap",permalink:"/api/interfaces/PortMap"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Source",id:"source",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"HostIp"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2114",children:"packages/extension-api/src/extension-api.d.ts:2114"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"HostPort"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2115",children:"packages/extension-api/src/extension-api.d.ts:2115"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{33505:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),o=t(71670);const s={},i="Interface: PortBinding",c={id:"interfaces/PortBinding",title:"Interface: PortBinding",description:"Properties",source:"@site/api/interfaces/PortBinding.md",sourceDirName:"interfaces",slug:"/interfaces/PortBinding",permalink:"/api/interfaces/PortBinding",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Port",permalink:"/api/interfaces/Port"},next:{title:"PortMap",permalink:"/api/interfaces/PortMap"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"HostIp?",id:"hostip",level:3},{value:"Source",id:"source",level:4},{value:"HostPort?",id:"hostport",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-portbinding",children:"Interface: PortBinding"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"hostip",children:"HostIp?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"HostIp"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2114",children:"packages/extension-api/src/extension-api.d.ts:2114"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"hostport",children:"HostPort?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"HostPort"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2115",children:"packages/extension-api/src/extension-api.d.ts:2115"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const o={},s=r.createContext(o);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94324b0e.8be2a011.js b/assets/js/94324b0e.d2561423.js similarity index 97% rename from assets/js/94324b0e.8be2a011.js rename to assets/js/94324b0e.d2561423.js index 72e964dacb6..6e8a9b97851 100644 --- a/assets/js/94324b0e.8be2a011.js +++ b/assets/js/94324b0e.d2561423.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{82658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=t(24246),s=t(71670);const r={},c="Function: createVolume()",i={id:"namespaces/containerEngine/functions/createVolume",title:"Function: createVolume()",description:"createVolume(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createPod",permalink:"/api/namespaces/containerEngine/functions/createPod"},next:{title:"deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createVolume"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateOptions",children:(0,o.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3410",children:"packages/extension-api/src/extension-api.d.ts:3410"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var o=t(27378);const s={},r=o.createContext(s);function c(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{82658:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>l});var o=t(24246),s=t(71670);const r={},c="Function: createVolume()",i={id:"namespaces/containerEngine/functions/createVolume",title:"Function: createVolume()",description:"createVolume(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createVolume.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createPod",permalink:"/api/namespaces/containerEngine/functions/createPod"},next:{title:"deleteContainer",permalink:"/api/namespaces/containerEngine/functions/deleteContainer"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-createvolume",children:"Function: createVolume()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"createVolume"}),"(",(0,o.jsx)(n.code,{children:"options"}),"?): ",(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"options?"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateOptions",children:(0,o.jsx)(n.code,{children:"VolumeCreateOptions"})})]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"})," <",(0,o.jsx)(n.a,{href:"/api/interfaces/VolumeCreateResponseInfo",children:(0,o.jsx)(n.code,{children:"VolumeCreateResponseInfo"})}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3410",children:"packages/extension-api/src/extension-api.d.ts:3410"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var o=t(27378);const s={},r=o.createContext(s);function c(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95646edb.c45f671a.js b/assets/js/95646edb.ec266694.js similarity index 86% rename from assets/js/95646edb.c45f671a.js rename to assets/js/95646edb.ec266694.js index a1d59ab7847..8221b38287e 100644 --- a/assets/js/95646edb.c45f671a.js +++ b/assets/js/95646edb.ec266694.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{25235:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const r={},c="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{25235:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const c={},r="Function: onEvent()",o={id:"namespaces/containerEngine/functions/onEvent",title:"Function: onEvent()",description:"onEvent(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/containerEngine/functions/onEvent.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/onEvent",permalink:"/api/namespaces/containerEngine/functions/onEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"logsContainer",permalink:"/api/namespaces/containerEngine/functions/logsContainer"},next:{title:"pullImage",permalink:"/api/namespaces/containerEngine/functions/pullImage"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-onevent",children:"Function: onEvent()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onEvent"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3401",children:"packages/extension-api/src/extension-api.d.ts:3401"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/97c7db18.62681153.js b/assets/js/97c7db18.e0c15752.js similarity index 95% rename from assets/js/97c7db18.62681153.js rename to assets/js/97c7db18.e0c15752.js index 388b5279f5c..310551bb59c 100644 --- a/assets/js/97c7db18.62681153.js +++ b/assets/js/97c7db18.e0c15752.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{78092:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerInspect()",c={id:"namespaces/navigation/functions/navigateToContainerInspect",title:"Function: navigateToContainerInspect()",description:"navigateToContainerInspect(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerInspect.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"},next:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4188",children:"packages/extension-api/src/extension-api.d.ts:4188"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{78092:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerInspect()",c={id:"namespaces/navigation/functions/navigateToContainerInspect",title:"Function: navigateToContainerInspect()",description:"navigateToContainerInspect(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerInspect.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer"},next:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerinspect",children:"Function: navigateToContainerInspect()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerInspect"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4188",children:"packages/extension-api/src/extension-api.d.ts:4188"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/97d49594.827c54ed.js b/assets/js/97d49594.d4ac0b5a.js similarity index 96% rename from assets/js/97d49594.827c54ed.js rename to assets/js/97d49594.d4ac0b5a.js index bc2591ea8cf..bd36848855a 100644 --- a/assets/js/97d49594.827c54ed.js +++ b/assets/js/97d49594.d4ac0b5a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{90816:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: inspectContainer()",c={id:"namespaces/containerEngine/functions/inspectContainer",title:"Function: inspectContainer()",description:"inspectContainer(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/inspectContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3206",children:"packages/extension-api/src/extension-api.d.ts:3206"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{90816:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: inspectContainer()",c={id:"namespaces/containerEngine/functions/inspectContainer",title:"Function: inspectContainer()",description:"inspectContainer(engineId, id): Promise \\",source:"@site/api/namespaces/containerEngine/functions/inspectContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/inspectContainer",permalink:"/api/namespaces/containerEngine/functions/inspectContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"info",permalink:"/api/namespaces/containerEngine/functions/info"},next:{title:"inspectManifest",permalink:"/api/namespaces/containerEngine/functions/inspectManifest"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{id:"function-inspectcontainer",children:"Function: inspectContainer()"}),"\n",(0,t.jsxs)(e.blockquote,{children:["\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.strong,{children:"inspectContainer"}),"(",(0,t.jsx)(e.code,{children:"engineId"}),", ",(0,t.jsx)(e.code,{children:"id"}),"): ",(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(e.p,{children:"Get the complete low-level information about a specific container."}),"\n",(0,t.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"engineId"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,t.jsxs)(e.p,{children:["\u2022 ",(0,t.jsx)(e.strong,{children:"id"}),": ",(0,t.jsx)(e.code,{children:"string"})]}),"\n",(0,t.jsxs)(e.p,{children:["the id or name of the container on this engine, obtained from the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,t.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,t.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(e.p,{children:[(0,t.jsx)(e.code,{children:"Promise"})," <",(0,t.jsx)(e.a,{href:"/api/interfaces/ContainerInspectInfo",children:(0,t.jsx)(e.code,{children:"ContainerInspectInfo"})}),">"]}),"\n",(0,t.jsx)(e.p,{children:"A promise resolving to a structure containing the container information"}),"\n",(0,t.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3206",children:"packages/extension-api/src/extension-api.d.ts:3206"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,t.jsx)(e,{...n,children:(0,t.jsx)(p,{...n})}):p(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);function o(n){const e=t.useContext(r);return t.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:o(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/97eb992d.c8c041c2.js b/assets/js/97eb992d.c9efb1ea.js similarity index 83% rename from assets/js/97eb992d.c8c041c2.js rename to assets/js/97eb992d.c9efb1ea.js index 47a3e605628..473237deb50 100644 --- a/assets/js/97eb992d.c8c041c2.js +++ b/assets/js/97eb992d.c9efb1ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{53544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: NetworkInspectInfo",d={id:"interfaces/NetworkInspectInfo",title:"Interface: NetworkInspectInfo",description:"Properties",source:"@site/api/interfaces/NetworkInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkInfo",permalink:"/api/interfaces/NetworkInfo"},next:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Source",id:"source",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Source",id:"source-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Source",id:"source-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-3",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Source",id:"source-7",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Source",id:"source-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Source",id:"source-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-11",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-17",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Attachable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2014",children:"packages/extension-api/src/extension-api.d.ts:2014"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ConfigFrom"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Network"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2016",children:"packages/extension-api/src/extension-api.d.ts:2016"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2017",children:"packages/extension-api/src/extension-api.d.ts:2017"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,i.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2018",children:"packages/extension-api/src/extension-api.d.ts:2018"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2008",children:"packages/extension-api/src/extension-api.d.ts:2008"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2010",children:"packages/extension-api/src/extension-api.d.ts:2010"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2011",children:"packages/extension-api/src/extension-api.d.ts:2011"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAM"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,i.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2012",children:"packages/extension-api/src/extension-api.d.ts:2012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2007",children:"packages/extension-api/src/extension-api.d.ts:2007"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ingress"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2015",children:"packages/extension-api/src/extension-api.d.ts:2015"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Internal"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2013",children:"packages/extension-api/src/extension-api.d.ts:2013"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2020",children:"packages/extension-api/src/extension-api.d.ts:2020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2006",children:"packages/extension-api/src/extension-api.d.ts:2006"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2019",children:"packages/extension-api/src/extension-api.d.ts:2019"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2009",children:"packages/extension-api/src/extension-api.d.ts:2009"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2003",children:"packages/extension-api/src/extension-api.d.ts:2003"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2004",children:"packages/extension-api/src/extension-api.d.ts:2004"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2005",children:"packages/extension-api/src/extension-api.d.ts:2005"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{53544:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: NetworkInspectInfo",d={id:"interfaces/NetworkInspectInfo",title:"Interface: NetworkInspectInfo",description:"Properties",source:"@site/api/interfaces/NetworkInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkInspectInfo",permalink:"/api/interfaces/NetworkInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkInfo",permalink:"/api/interfaces/NetworkInfo"},next:{title:"NetworkStats",permalink:"/api/interfaces/NetworkStats"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"Attachable",id:"attachable",level:3},{value:"Source",id:"source",level:4},{value:"ConfigFrom?",id:"configfrom",level:3},{value:"Network",id:"network",level:4},{value:"Source",id:"source-1",level:4},{value:"ConfigOnly",id:"configonly",level:3},{value:"Source",id:"source-2",level:4},{value:"Containers?",id:"containers",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-3",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-4",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-5",level:4},{value:"EnableIPv6",id:"enableipv6",level:3},{value:"Source",id:"source-6",level:4},{value:"IPAM?",id:"ipam",level:3},{value:"Source",id:"source-7",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-8",level:4},{value:"Ingress",id:"ingress",level:3},{value:"Source",id:"source-9",level:4},{value:"Internal",id:"internal",level:3},{value:"Source",id:"source-10",level:4},{value:"Labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-11",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-12",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-13",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-14",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-15",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-16",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-17",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Attachable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2014",children:"packages/extension-api/src/extension-api.d.ts:2014"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ConfigFrom"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Network"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2016",children:"packages/extension-api/src/extension-api.d.ts:2016"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2017",children:"packages/extension-api/src/extension-api.d.ts:2017"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Containers"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,i.jsx)(n.code,{children:"NetworkContainer"})})]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2018",children:"packages/extension-api/src/extension-api.d.ts:2018"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2008",children:"packages/extension-api/src/extension-api.d.ts:2008"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2010",children:"packages/extension-api/src/extension-api.d.ts:2010"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2011",children:"packages/extension-api/src/extension-api.d.ts:2011"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IPAM"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,i.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2012",children:"packages/extension-api/src/extension-api.d.ts:2012"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2007",children:"packages/extension-api/src/extension-api.d.ts:2007"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ingress"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2015",children:"packages/extension-api/src/extension-api.d.ts:2015"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Internal"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2013",children:"packages/extension-api/src/extension-api.d.ts:2013"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2020",children:"packages/extension-api/src/extension-api.d.ts:2020"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2006",children:"packages/extension-api/src/extension-api.d.ts:2006"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2019",children:"packages/extension-api/src/extension-api.d.ts:2019"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2009",children:"packages/extension-api/src/extension-api.d.ts:2009"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2003",children:"packages/extension-api/src/extension-api.d.ts:2003"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2004",children:"packages/extension-api/src/extension-api.d.ts:2004"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineType"}),": ",(0,i.jsx)(n.code,{children:'"docker"'})," | ",(0,i.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2005",children:"packages/extension-api/src/extension-api.d.ts:2005"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/98ced590.334f13a0.js b/assets/js/98ced590.8b0d8b20.js similarity index 95% rename from assets/js/98ced590.334f13a0.js rename to assets/js/98ced590.8b0d8b20.js index d3774e21337..e9362d1738c 100644 --- a/assets/js/98ced590.334f13a0.js +++ b/assets/js/98ced590.8b0d8b20.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{46443:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{46443:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainerTerminal()",r={id:"namespaces/navigation/functions/navigateToContainerTerminal",title:"Function: navigateToContainerTerminal()",description:"navigateToContainerTerminal(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs"},next:{title:"navigateToContainers",permalink:"/api/namespaces/navigation/functions/navigateToContainers"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainerterminal",children:"Function: navigateToContainerTerminal()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainerTerminal"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4190",children:"packages/extension-api/src/extension-api.d.ts:4190"})})]})}function u(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9af13eab.c050981e.js b/assets/js/9af13eab.c050981e.js new file mode 100644 index 00000000000..907b0eb6710 --- /dev/null +++ b/assets/js/9af13eab.c050981e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{15745:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Function: getContainerConnections()",s={id:"namespaces/provider/functions/getContainerConnections",title:"Function: getContainerConnections()",description:"getContainerConnections(): ProviderContainerConnection[]",source:"@site/api/namespaces/provider/functions/getContainerConnections.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createProvider",permalink:"/api/namespaces/provider/functions/createProvider"},next:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-getcontainerconnections",children:"Function: getContainerConnections()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"getContainerConnections"}),"(): ",(0,o.jsx)(n.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(n.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(n.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})})]})}function u(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9af13eab.c5e91988.js b/assets/js/9af13eab.c5e91988.js deleted file mode 100644 index e431e6ec6f9..00000000000 --- a/assets/js/9af13eab.c5e91988.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{15745:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Function: getContainerConnections()",s={id:"namespaces/provider/functions/getContainerConnections",title:"Function: getContainerConnections()",description:"getContainerConnections(): ProviderContainerConnection[]",source:"@site/api/namespaces/provider/functions/getContainerConnections.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/getContainerConnections",permalink:"/api/namespaces/provider/functions/getContainerConnections",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createProvider",permalink:"/api/namespaces/provider/functions/createProvider"},next:{title:"getProviderLifecycleContext",permalink:"/api/namespaces/provider/functions/getProviderLifecycleContext"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getcontainerconnections",children:"Function: getContainerConnections()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getContainerConnections"}),"(): ",(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.a,{href:"/api/interfaces/ProviderContainerConnection",children:(0,o.jsx)(e.code,{children:"ProviderContainerConnection"})}),"[]"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})})]})}function u(n={}){const{wrapper:e}={...(0,r.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(n){const e=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function s(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(r):n.components||r:c(n.components),o.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/9c540f0b.8bb61dd4.js b/assets/js/9c540f0b.e11b6540.js similarity index 85% rename from assets/js/9c540f0b.8bb61dd4.js rename to assets/js/9c540f0b.e11b6540.js index 9b20f868ba9..232521bdbde 100644 --- a/assets/js/9c540f0b.8bb61dd4.js +++ b/assets/js/9c540f0b.e11b6540.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{29698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var i=s(24246),o=s(71670);const r={},c="Interface: MountSettings",d={id:"interfaces/MountSettings",title:"Interface: MountSettings",description:"Properties",source:"@site/api/interfaces/MountSettings.md",sourceDirName:"interfaces",slug:"/interfaces/MountSettings",permalink:"/api/interfaces/MountSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"},next:{title:"NetworkContainer",permalink:"/api/interfaces/NetworkContainer"}},t={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Source",id:"source",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Source",id:"source-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Source",id:"source-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Source",id:"source-3",level:4},{value:"Source",id:"source-4",level:3},{value:"Source",id:"source-5",level:4},{value:"Target",id:"target",level:3},{value:"Source",id:"source-6",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Source",id:"source-7",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-8",level:4},{value:"VolumeOptions?",id:"volumeoptions",level:3},{value:"DriverConfig",id:"driverconfig",level:4},{value:"DriverConfig.Name",id:"driverconfigname",level:4},{value:"DriverConfig.Options",id:"driverconfigoptions",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"NoCopy",id:"nocopy",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BindOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Propagation"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,i.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Consistency"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,i.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"source-4",children:"Source"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Source"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2135",children:"packages/extension-api/src/extension-api.d.ts:2135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"TmpfsOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,i.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2136",children:"packages/extension-api/src/extension-api.d.ts:2136"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumeOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NoCopy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>c});var i=s(27378);const o={},r=i.createContext(o);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{29698:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var i=s(24246),o=s(71670);const c={},r="Interface: MountSettings",t={id:"interfaces/MountSettings",title:"Interface: MountSettings",description:"Properties",source:"@site/api/interfaces/MountSettings.md",sourceDirName:"interfaces",slug:"/interfaces/MountSettings",permalink:"/api/interfaces/MountSettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MenuItem",permalink:"/api/interfaces/MenuItem"},next:{title:"NetworkContainer",permalink:"/api/interfaces/NetworkContainer"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"BindOptions?",id:"bindoptions",level:3},{value:"Propagation",id:"propagation",level:4},{value:"Source",id:"source",level:4},{value:"Consistency?",id:"consistency",level:3},{value:"Source",id:"source-1",level:4},{value:"Mode?",id:"mode",level:3},{value:"Source",id:"source-2",level:4},{value:"ReadOnly?",id:"readonly",level:3},{value:"Source",id:"source-3",level:4},{value:"Source",id:"source-4",level:3},{value:"Source",id:"source-5",level:4},{value:"Target",id:"target",level:3},{value:"Source",id:"source-6",level:4},{value:"TmpfsOptions?",id:"tmpfsoptions",level:3},{value:"Mode",id:"mode-1",level:4},{value:"SizeBytes",id:"sizebytes",level:4},{value:"Source",id:"source-7",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-8",level:4},{value:"VolumeOptions?",id:"volumeoptions",level:3},{value:"DriverConfig",id:"driverconfig",level:4},{value:"DriverConfig.Name",id:"driverconfigname",level:4},{value:"DriverConfig.Options",id:"driverconfigoptions",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"NoCopy",id:"nocopy",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-mountsettings",children:"Interface: MountSettings"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"bindoptions",children:"BindOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BindOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"propagation",children:"Propagation"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Propagation"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountPropagation",children:(0,i.jsx)(n.code,{children:"MountPropagation"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consistency",children:"Consistency?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Consistency"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConsistency",children:(0,i.jsx)(n.code,{children:"MountConsistency"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2138",children:"packages/extension-api/src/extension-api.d.ts:2138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mode",children:"Mode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonly",children:"ReadOnly?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadOnly"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2137",children:"packages/extension-api/src/extension-api.d.ts:2137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"source-4",children:"Source"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Source"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2135",children:"packages/extension-api/src/extension-api.d.ts:2135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"target",children:"Target"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Target"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfsoptions",children:"TmpfsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"TmpfsOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"mode-1",children:"Mode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sizebytes",children:"SizeBytes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SizeBytes"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2151",children:"packages/extension-api/src/extension-api.d.ts:2151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountType",children:(0,i.jsx)(n.code,{children:"MountType"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2136",children:"packages/extension-api/src/extension-api.d.ts:2136"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumeoptions",children:"VolumeOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumeOptions"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfig",children:"DriverConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DriverConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigname",children:"DriverConfig.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"driverconfigoptions",children:"DriverConfig.Options"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"nocopy",children:"NoCopy"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NoCopy"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d2d4743.c2ea0190.js b/assets/js/9d2d4743.5ec0c4d5.js similarity index 94% rename from assets/js/9d2d4743.c2ea0190.js rename to assets/js/9d2d4743.5ec0c4d5.js index 0e59e65256e..1599e484728 100644 --- a/assets/js/9d2d4743.c2ea0190.js +++ b/assets/js/9d2d4743.5ec0c4d5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{22313:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Interface: ContainerProviderConnectionEndpoint",s={id:"interfaces/ContainerProviderConnectionEndpoint",title:"Interface: ContainerProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"},next:{title:"ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"socketPath",id:"socketpath",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L280",children:"packages/extension-api/src/extension-api.d.ts:280"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{22313:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var o=t(24246),r=t(71670);const i={},c="Interface: ContainerProviderConnectionEndpoint",s={id:"interfaces/ContainerProviderConnectionEndpoint",title:"Interface: ContainerProviderConnectionEndpoint",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnectionEndpoint.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection"},next:{title:"ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"socketPath",id:"socketpath",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-containerproviderconnectionendpoint",children:"Interface: ContainerProviderConnectionEndpoint"}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"socketpath",children:"socketPath"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"socketPath"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L280",children:"packages/extension-api/src/extension-api.d.ts:280"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var o=t(27378);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d887a11.e1c626e0.js b/assets/js/9d887a11.b65da091.js similarity index 98% rename from assets/js/9d887a11.e1c626e0.js rename to assets/js/9d887a11.b65da091.js index 967eb343b48..cfae5344ab0 100644 --- a/assets/js/9d887a11.e1c626e0.js +++ b/assets/js/9d887a11.b65da091.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{94806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const r={},c="Function: createWebviewPanel()",a={id:"namespaces/window/functions/createWebviewPanel",title:"Function: createWebviewPanel()",description:"createWebviewPanel(viewType, title, options?): WebviewPanel",source:"@site/api/namespaces/window/functions/createWebviewPanel.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"},next:{title:"listWebviews",permalink:"/api/namespaces/window/functions/listWebviews"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,i.jsx)(n.code,{children:"viewType"}),", ",(0,i.jsx)(n.code,{children:"title"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Settings for the new panel."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,i.jsx)(n.p,{children:"New webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1833",children:"packages/extension-api/src/extension-api.d.ts:1833"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{94806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const r={},c="Function: createWebviewPanel()",a={id:"namespaces/window/functions/createWebviewPanel",title:"Function: createWebviewPanel()",description:"createWebviewPanel(viewType, title, options?): WebviewPanel",source:"@site/api/namespaces/window/functions/createWebviewPanel.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"},next:{title:"listWebviews",permalink:"/api/namespaces/window/functions/listWebviews"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-createwebviewpanel",children:"Function: createWebviewPanel()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"createWebviewPanel"}),"(",(0,i.jsx)(n.code,{children:"viewType"}),", ",(0,i.jsx)(n.code,{children:"title"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Create and show a new webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"viewType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Identifies the type of the webview panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"Title of the panel."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewOptions",children:(0,i.jsx)(n.code,{children:"WebviewOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"Settings for the new panel."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/interfaces/WebviewPanel",children:(0,i.jsx)(n.code,{children:"WebviewPanel"})})}),"\n",(0,i.jsx)(n.p,{children:"New webview panel."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1833",children:"packages/extension-api/src/extension-api.d.ts:1833"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const s={},r=i.createContext(s);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9db962b6.a760b6a3.js b/assets/js/9db962b6.ebf42e7b.js similarity index 96% rename from assets/js/9db962b6.a760b6a3.js rename to assets/js/9db962b6.ebf42e7b.js index 36e4c5b76d1..c142d323d06 100644 --- a/assets/js/9db962b6.a760b6a3.js +++ b/assets/js/9db962b6.ebf42e7b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{54100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateKubernetesConnection()",c={id:"namespaces/provider/functions/onDidUpdateKubernetesConnection",title:"Function: onDidUpdateKubernetesConnection()",description:"onDidUpdateKubernetesConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"},next:{title:"onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{54100:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: onDidUpdateKubernetesConnection()",c={id:"namespaces/provider/functions/onDidUpdateKubernetesConnection",title:"Function: onDidUpdateKubernetesConnection()",description:"onDidUpdateKubernetesConnection(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateContainerConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateContainerConnection"},next:{title:"onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubernetesconnection",children:"Function: onDidUpdateKubernetesConnection()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubernetesConnection"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9dd60997.154ea2ff.js b/assets/js/9dd60997.85ca45b0.js similarity index 96% rename from assets/js/9dd60997.154ea2ff.js rename to assets/js/9dd60997.85ca45b0.js index 08d5a35ba10..0885723b42e 100644 --- a/assets/js/9dd60997.154ea2ff.js +++ b/assets/js/9dd60997.85ca45b0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{27456:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: authentication",permalink:"/api/namespaces/authentication/"},next:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"}},d={},a=[{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options-1",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session if available, or undefined if there are no sessions"}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3665",children:"packages/extension-api/src/extension-api.d.ts:3665"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{27456:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var i=s(24246),t=s(71670);const o={},r="Function: getSession()",c={id:"namespaces/authentication/functions/getSession",title:"Function: getSession()",description:"getSession(providerId, scopes, options)",source:"@site/api/namespaces/authentication/functions/getSession.md",sourceDirName:"namespaces/authentication/functions",slug:"/namespaces/authentication/functions/getSession",permalink:"/api/namespaces/authentication/functions/getSession",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: authentication",permalink:"/api/namespaces/authentication/"},next:{title:"onDidChangeSessions",permalink:"/api/namespaces/authentication/functions/onDidChangeSessions"}},d={},a=[{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Source",id:"source",level:3},{value:"getSession(providerId, scopes, options)",id:"getsessionproviderid-scopes-options-1",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Source",id:"source-1",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-getsession",children:"Function: getSession()"}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})," & ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session"}),"\n",(0,i.jsx)(n.h3,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3646",children:"packages/extension-api/src/extension-api.d.ts:3646"})}),"\n",(0,i.jsx)(n.h2,{id:"getsessionproviderid-scopes-options-1",children:"getSession(providerId, scopes, options)"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"getSession"}),"(",(0,i.jsx)(n.code,{children:"providerId"}),", ",(0,i.jsx)(n.code,{children:"scopes"}),", ",(0,i.jsx)(n.code,{children:"options"}),"?): ",(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not\nregistered, or if the user does not consent to sharing authentication information with\nthe extension. If there are multiple sessions with the same scopes, the user will be shown a\nquickpick to select which account they would like to use."}),"\n",(0,i.jsx)(n.p,{children:"Currently, there are only two authentication providers that are contributed from built in extensions\nto VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'."}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The id of the provider to use"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"scopes"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A list of scopes representing the permissions requested. These are dependent on the authentication provider"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions",children:(0,i.jsx)(n.code,{children:"AuthenticationGetSessionOptions"})})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.a,{href:"#GetSessionOptions",children:"getSessionOptions"})," to use"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"})," <",(0,i.jsx)(n.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(n.code,{children:"AuthenticationSession"})})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"A promise that resolves to an authentication session if available, or undefined if there are no sessions"}),"\n",(0,i.jsx)(n.h3,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3665",children:"packages/extension-api/src/extension-api.d.ts:3665"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a08dfa31.0afb1a55.js b/assets/js/a08dfa31.515fb56d.js similarity index 87% rename from assets/js/a08dfa31.0afb1a55.js rename to assets/js/a08dfa31.515fb56d.js index d15e33995a5..95cf2917d2f 100644 --- a/assets/js/a08dfa31.0afb1a55.js +++ b/assets/js/a08dfa31.515fb56d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{95971:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: ProviderOptions",t={id:"interfaces/ProviderOptions",title:"Interface: ProviderOptions",description:"Properties",source:"@site/api/interfaces/ProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderOptions",permalink:"/api/interfaces/ProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"},next:{title:"ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"links?",id:"links",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-6",level:4},{value:"version?",id:"version",level:3},{value:"Source",id:"source-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,i.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L242",children:"packages/extension-api/src/extension-api.d.ts:242"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"emptyConnectionMarkdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L248",children:"packages/extension-api/src/extension-api.d.ts:248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L236",children:"packages/extension-api/src/extension-api.d.ts:236"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"links"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L241",children:"packages/extension-api/src/extension-api.d.ts:241"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L237",children:"packages/extension-api/src/extension-api.d.ts:237"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,i.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L238",children:"packages/extension-api/src/extension-api.d.ts:238"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L239",children:"packages/extension-api/src/extension-api.d.ts:239"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"warnings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"warnings"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,i.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L245",children:"packages/extension-api/src/extension-api.d.ts:245"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{95971:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),r=s(71670);const c={},o="Interface: ProviderOptions",t={id:"interfaces/ProviderOptions",title:"Interface: ProviderOptions",description:"Properties",source:"@site/api/interfaces/ProviderOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderOptions",permalink:"/api/interfaces/ProviderOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"},next:{title:"ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"detectionChecks?",id:"detectionchecks",level:3},{value:"Source",id:"source",level:4},{value:"emptyConnectionMarkdownDescription?",id:"emptyconnectionmarkdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-2",level:4},{value:"images?",id:"images",level:3},{value:"Source",id:"source-3",level:4},{value:"links?",id:"links",level:3},{value:"Source",id:"source-4",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-5",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-6",level:4},{value:"version?",id:"version",level:3},{value:"Source",id:"source-7",level:4},{value:"warnings?",id:"warnings",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-provideroptions",children:"Interface: ProviderOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"detectionchecks",children:"detectionChecks?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"detectionChecks"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderDetectionCheck",children:(0,i.jsx)(n.code,{children:"ProviderDetectionCheck"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L242",children:"packages/extension-api/src/extension-api.d.ts:242"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"emptyconnectionmarkdowndescription",children:"emptyConnectionMarkdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"emptyConnectionMarkdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L248",children:"packages/extension-api/src/extension-api.d.ts:248"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L236",children:"packages/extension-api/src/extension-api.d.ts:236"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"images",children:"images?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"images"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderImages",children:(0,i.jsx)(n.code,{children:"ProviderImages"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"links"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,i.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L241",children:"packages/extension-api/src/extension-api.d.ts:241"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L237",children:"packages/extension-api/src/extension-api.d.ts:237"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderStatus",children:(0,i.jsx)(n.code,{children:"ProviderStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L238",children:"packages/extension-api/src/extension-api.d.ts:238"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"version",children:"version?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"version"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L239",children:"packages/extension-api/src/extension-api.d.ts:239"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"warnings",children:"warnings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"warnings"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderInformation",children:(0,i.jsx)(n.code,{children:"ProviderInformation"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L245",children:"packages/extension-api/src/extension-api.d.ts:245"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const r={},c=i.createContext(r);function o(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2c6f402.88a88e82.js b/assets/js/a2c6f402.7387de79.js similarity index 94% rename from assets/js/a2c6f402.88a88e82.js rename to assets/js/a2c6f402.7387de79.js index 7f858d4178e..fd450eefe34 100644 --- a/assets/js/a2c6f402.88a88e82.js +++ b/assets/js/a2c6f402.7387de79.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{79199:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="Type alias: ProviderLinks",a={id:"type-aliases/ProviderLinks",title:"Type alias: ProviderLinks",description:"ProviderLinks: Link",source:"@site/api/type-aliases/ProviderLinks.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderLinks",permalink:"/api/type-aliases/ProviderLinks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-providerlinks",children:"Type alias: ProviderLinks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ProviderLinks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{79199:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var s=t(24246),i=t(71670);const r={},o="Type alias: ProviderLinks",a={id:"type-aliases/ProviderLinks",title:"Type alias: ProviderLinks",description:"ProviderLinks: Link",source:"@site/api/type-aliases/ProviderLinks.md",sourceDirName:"type-aliases",slug:"/type-aliases/ProviderLinks",permalink:"/api/type-aliases/ProviderLinks",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"},next:{title:"ProviderResult",permalink:"/api/type-aliases/ProviderResult"}},c={},d=[{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"type-alias-providerlinks",children:"Type alias: ProviderLinks"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"ProviderLinks"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,s.jsx)(n.code,{children:"Link"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L456",children:"packages/extension-api/src/extension-api.d.ts:456"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var s=t(27378);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2d1ff94.b85b6e5a.js b/assets/js/a2d1ff94.26abb8a7.js similarity index 93% rename from assets/js/a2d1ff94.b85b6e5a.js rename to assets/js/a2d1ff94.26abb8a7.js index 60b598e4b26..74d26abac6a 100644 --- a/assets/js/a2d1ff94.b85b6e5a.js +++ b/assets/js/a2d1ff94.26abb8a7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{65150:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const o={},s="Interface: ContainerProviderConnection",c={id:"interfaces/ContainerProviderConnection",title:"Interface: ContainerProviderConnection",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"},next:{title:"ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"endpoint"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L286",children:"packages/extension-api/src/extension-api.d.ts:286"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L287",children:"packages/extension-api/src/extension-api.d.ts:287"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L284",children:"packages/extension-api/src/extension-api.d.ts:284"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"type"}),": ",(0,r.jsx)(n.code,{children:'"docker"'})," | ",(0,r.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L285",children:"packages/extension-api/src/extension-api.d.ts:285"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L288",children:"packages/extension-api/src/extension-api.d.ts:288"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{65150:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=i(24246),t=i(71670);const o={},s="Interface: ContainerProviderConnection",c={id:"interfaces/ContainerProviderConnection",title:"Interface: ContainerProviderConnection",description:"Properties",source:"@site/api/interfaces/ContainerProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnection",permalink:"/api/interfaces/ContainerProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"},next:{title:"ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-3",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"endpoint"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L286",children:"packages/extension-api/src/extension-api.d.ts:286"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"lifecycle"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,r.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L287",children:"packages/extension-api/src/extension-api.d.ts:287"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L284",children:"packages/extension-api/src/extension-api.d.ts:284"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"type"}),": ",(0,r.jsx)(n.code,{children:'"docker"'})," | ",(0,r.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L285",children:"packages/extension-api/src/extension-api.d.ts:285"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),"(): ",(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,r.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L288",children:"packages/extension-api/src/extension-api.d.ts:288"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a2ffcc0f.84eaf400.js b/assets/js/a2ffcc0f.5504db9a.js similarity index 85% rename from assets/js/a2ffcc0f.84eaf400.js rename to assets/js/a2ffcc0f.5504db9a.js index c34b1671c3b..36607ee49b5 100644 --- a/assets/js/a2ffcc0f.84eaf400.js +++ b/assets/js/a2ffcc0f.5504db9a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{49351:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>a,toc:()=>u});var s=r(24246),t=r(71670);const o={},i="Function: registerKubernetesGenerator()",a={id:"namespaces/kubernetes/functions/registerKubernetesGenerator",title:"Function: registerKubernetesGenerator()",description:"registerKubernetesGenerator(provider): Disposable",source:"@site/api/namespaces/kubernetes/functions/registerKubernetesGenerator.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"},next:{title:"setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig"}},c={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1857",children:"packages/extension-api/src/extension-api.d.ts:1857"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>a,a:()=>i});var s=r(27378);const t={},o=s.createContext(t);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{49351:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var s=r(24246),t=r(71670);const o={},i="Function: registerKubernetesGenerator()",c={id:"namespaces/kubernetes/functions/registerKubernetesGenerator",title:"Function: registerKubernetesGenerator()",description:"registerKubernetesGenerator(provider): Disposable",source:"@site/api/namespaces/kubernetes/functions/registerKubernetesGenerator.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig"},next:{title:"setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-registerkubernetesgenerator",children:"Function: registerKubernetesGenerator()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"registerKubernetesGenerator"}),"(",(0,s.jsx)(n.code,{children:"provider"}),"): ",(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Add a KubernetesGenerator to KubernetesGeneratorRegistry"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"provider"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesGeneratorProvider",children:(0,s.jsx)(n.code,{children:"KubernetesGeneratorProvider"})})]}),"\n",(0,s.jsx)(n.p,{children:"the custom provider to add"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,s.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1857",children:"packages/extension-api/src/extension-api.d.ts:1857"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>i});var s=r(27378);const t={},o=s.createContext(t);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3002291.91ac2aaf.js b/assets/js/a3002291.b486dcf8.js similarity index 96% rename from assets/js/a3002291.91ac2aaf.js rename to assets/js/a3002291.b486dcf8.js index 995abb6fa01..6104699c238 100644 --- a/assets/js/a3002291.91ac2aaf.js +++ b/assets/js/a3002291.b486dcf8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{483:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var r=t(24246),o=t(71670);const c={},s="Function: createNetwork()",i={id:"namespaces/containerEngine/functions/createNetwork",title:"Function: createNetwork()",description:"createNetwork(containerProviderConnection, networkCreateOptions): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createNetwork.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"},next:{title:"createPod",permalink:"/api/namespaces/containerEngine/functions/createPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3404",children:"packages/extension-api/src/extension-api.d.ts:3404"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>s});var r=t(27378);const o={},c=r.createContext(o);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{483:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>d});var r=t(24246),o=t(71670);const c={},s="Function: createNetwork()",i={id:"namespaces/containerEngine/functions/createNetwork",title:"Function: createNetwork()",description:"createNetwork(containerProviderConnection, networkCreateOptions): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createNetwork.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"},next:{title:"createPod",permalink:"/api/namespaces/containerEngine/functions/createPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createnetwork",children:"Function: createNetwork()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createNetwork"}),"(",(0,r.jsx)(n.code,{children:"containerProviderConnection"}),", ",(0,r.jsx)(n.code,{children:"networkCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerProviderConnection"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"networkCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateOptions",children:(0,r.jsx)(n.code,{children:"NetworkCreateOptions"})})]}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/NetworkCreateResult",children:(0,r.jsx)(n.code,{children:"NetworkCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3404",children:"packages/extension-api/src/extension-api.d.ts:3404"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>s});var r=t(27378);const o={},c=r.createContext(o);function s(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a30c0d44.c2230f3d.js b/assets/js/a30c0d44.d7c6b3c1.js similarity index 91% rename from assets/js/a30c0d44.c2230f3d.js rename to assets/js/a30c0d44.d7c6b3c1.js index a9fe9add012..b3496b0afa1 100644 --- a/assets/js/a30c0d44.c2230f3d.js +++ b/assets/js/a30c0d44.d7c6b3c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{47516:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Interface: InputBoxOptions",c={id:"interfaces/InputBoxOptions",title:"Interface: InputBoxOptions",description:"Options to configure the behavior of the input box UI.",source:"@site/api/interfaces/InputBoxOptions.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"},next:{title:"InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Source",id:"source-2",level:4},{value:"password?",id:"password",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Source",id:"source-5",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-6",level:4},{value:"value?",id:"value",level:3},{value:"Source",id:"source-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"validateInput()?",id:"validateinput",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," to keep the input box open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L918",children:"packages/extension-api/src/extension-api.d.ts:918"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A description of the field to be show (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"multiline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L923",children:"packages/extension-api/src/extension-api.d.ts:923"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"password",children:"password?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"password"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"placeHolder"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to type."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"prompt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L897",children:"packages/extension-api/src/extension-api.d.ts:897"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string that represents the title of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L879",children:"packages/extension-api/src/extension-api.d.ts:879"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"value",children:"value?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"valueSelection"}),": [",(0,i.jsx)(n.code,{children:"number"}),", ",(0,i.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,i.jsx)(n.code,{children:"value"})}),". Defined as tuple of two number where the\nfirst is the inclusive start index and the second the exclusive end index. When ",(0,i.jsx)(n.code,{children:"undefined"})," the whole\npre-filled value will be selected, when empty (start equals end) only the cursor will be set,\notherwise the defined range will be selected."]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"validateInput"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The current value of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,i.jsx)(n.code,{children:"undefined"}),", ",(0,i.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L933",children:"packages/extension-api/src/extension-api.d.ts:933"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{47516:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Interface: InputBoxOptions",c={id:"interfaces/InputBoxOptions",title:"Interface: InputBoxOptions",description:"Options to configure the behavior of the input box UI.",source:"@site/api/interfaces/InputBoxOptions.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageInspectInfo",permalink:"/api/interfaces/ImageInspectInfo"},next:{title:"InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"ignoreFocusOut?",id:"ignorefocusout",level:3},{value:"Source",id:"source",level:4},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source-1",level:4},{value:"multiline?",id:"multiline",level:3},{value:"Source",id:"source-2",level:4},{value:"password?",id:"password",level:3},{value:"Source",id:"source-3",level:4},{value:"placeHolder?",id:"placeholder",level:3},{value:"Source",id:"source-4",level:4},{value:"prompt?",id:"prompt",level:3},{value:"Source",id:"source-5",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-6",level:4},{value:"value?",id:"value",level:3},{value:"Source",id:"source-7",level:4},{value:"valueSelection?",id:"valueselection",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"validateInput()?",id:"validateinput",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-inputboxoptions",children:"Interface: InputBoxOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options to configure the behavior of the input box UI."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ignoreFocusOut"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," to keep the input box open when focus moves to another part of the editor or to another window.\nThis setting is ignored on iPad and is always false."]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L918",children:"packages/extension-api/src/extension-api.d.ts:918"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A description of the field to be show (Markdown format)"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"multiline",children:"multiline?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"multiline"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set to ",(0,i.jsx)(n.code,{children:"true"})," when value represents a multi line content."]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L923",children:"packages/extension-api/src/extension-api.d.ts:923"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"password",children:"password?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"password"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Controls if a password input is shown. Password input hides the typed text."}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L912",children:"packages/extension-api/src/extension-api.d.ts:912"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"placeHolder"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string to show as placeholder in the input box to guide the user what to type."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L907",children:"packages/extension-api/src/extension-api.d.ts:907"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"prompt",children:"prompt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"prompt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The text to display underneath the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L897",children:"packages/extension-api/src/extension-api.d.ts:897"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional string that represents the title of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L879",children:"packages/extension-api/src/extension-api.d.ts:879"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"value",children:"value?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The value to pre-fill in the input box."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L884",children:"packages/extension-api/src/extension-api.d.ts:884"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"valueselection",children:"valueSelection?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"valueSelection"}),": [",(0,i.jsx)(n.code,{children:"number"}),", ",(0,i.jsx)(n.code,{children:"number"}),"]"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Selection of the pre-filled ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxOptions#value",children:(0,i.jsx)(n.code,{children:"value"})}),". Defined as tuple of two number where the\nfirst is the inclusive start index and the second the exclusive end index. When ",(0,i.jsx)(n.code,{children:"undefined"})," the whole\npre-filled value will be selected, when empty (start equals end) only the cursor will be set,\notherwise the defined range will be selected."]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L892",children:"packages/extension-api/src/extension-api.d.ts:892"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"validateinput",children:"validateInput()?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"validateInput"}),"(",(0,i.jsx)(n.code,{children:"value"}),"): ",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional function that will be called to validate input and to give a hint\nto the user."}),"\n",(0,i.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"value"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The current value of the input box."}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})})," | ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"undefined"})," | ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:(0,i.jsx)(n.code,{children:"InputBoxValidationMessage"})}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["Either a human-readable string which is presented as an error message or an ",(0,i.jsx)(n.a,{href:"/api/interfaces/InputBoxValidationMessage",children:"InputBoxValidationMessage"}),"\nwhich can provide a specific message severity. Return ",(0,i.jsx)(n.code,{children:"undefined"}),", ",(0,i.jsx)(n.code,{children:"null"}),", or the empty string when 'value' is valid."]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L933",children:"packages/extension-api/src/extension-api.d.ts:933"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a334b453.b3a02fb6.js b/assets/js/a334b453.07a4e4c2.js similarity index 95% rename from assets/js/a334b453.b3a02fb6.js rename to assets/js/a334b453.07a4e4c2.js index acfb70abed9..0db271f3815 100644 --- a/assets/js/a334b453.b3a02fb6.js +++ b/assets/js/a334b453.07a4e4c2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{53987:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L553",children:"packages/extension-api/src/extension-api.d.ts:553"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L552",children:"packages/extension-api/src/extension-api.d.ts:552"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{53987:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=t(24246),o=t(71670);const r={},s="Interface: UpdateContainerConnectionEvent",c={id:"interfaces/UpdateContainerConnectionEvent",title:"Interface: UpdateContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UnregisterKubernetesConnectionEvent",permalink:"/api/interfaces/UnregisterKubernetesConnectionEvent"},next:{title:"UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-updatecontainerconnectionevent",children:"Interface: UpdateContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L553",children:"packages/extension-api/src/extension-api.d.ts:553"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L552",children:"packages/extension-api/src/extension-api.d.ts:552"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const o={},r=i.createContext(o);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a38d285e.82dfec5c.js b/assets/js/a38d285e.69fa8c7d.js similarity index 92% rename from assets/js/a38d285e.82dfec5c.js rename to assets/js/a38d285e.69fa8c7d.js index d5155ba9872..f069f3dfcf9 100644 --- a/assets/js/a38d285e.82dfec5c.js +++ b/assets/js/a38d285e.69fa8c7d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{11991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: RegisterContainerConnectionEvent",s={id:"interfaces/RegisterContainerConnectionEvent",title:"Interface: RegisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"},next:{title:"RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L573",children:"packages/extension-api/src/extension-api.d.ts:573"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{11991:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: RegisterContainerConnectionEvent",s={id:"interfaces/RegisterContainerConnectionEvent",title:"Interface: RegisterContainerConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterContainerConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"QuickPickOptions",permalink:"/api/interfaces/QuickPickOptions"},next:{title:"RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-registercontainerconnectionevent",children:"Interface: RegisterContainerConnectionEvent"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"connection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"providerId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L573",children:"packages/extension-api/src/extension-api.d.ts:573"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>c});var i=t(27378);const r={},o=i.createContext(r);function c(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3f8794a.8e650d99.js b/assets/js/a3f8794a.1542b189.js similarity index 96% rename from assets/js/a3f8794a.8e650d99.js rename to assets/js/a3f8794a.1542b189.js index dc8b18f02cf..a23c3b620a0 100644 --- a/assets/js/a3f8794a.8e650d99.js +++ b/assets/js/a3f8794a.1542b189.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{84214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const a={},s="Function: createContainer()",c={id:"namespaces/containerEngine/functions/createContainer",title:"Function: createContainer()",description:"createContainer(engineId, containerCreateOptions): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createcontainer",children:"Function: createContainer()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createContainer"}),"(",(0,r.jsx)(n.code,{children:"engineId"}),", ",(0,r.jsx)(n.code,{children:"containerCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,r.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Create a new container on a specific container engine"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["the id of the engine on which to create the container, obtained from the result of ",(0,r.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateOptions",children:(0,r.jsx)(n.code,{children:"ContainerCreateOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the details of the container to create"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,r.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise resolving to the information on the created container"}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3215",children:"packages/extension-api/src/extension-api.d.ts:3215"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},a=r.createContext(i);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{84214:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const a={},s="Function: createContainer()",c={id:"namespaces/containerEngine/functions/createContainer",title:"Function: createContainer()",description:"createContainer(engineId, containerCreateOptions): Promise \\",source:"@site/api/namespaces/containerEngine/functions/createContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createContainer",permalink:"/api/namespaces/containerEngine/functions/createContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"buildImage",permalink:"/api/namespaces/containerEngine/functions/buildImage"},next:{title:"createManifest",permalink:"/api/namespaces/containerEngine/functions/createManifest"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"function-createcontainer",children:"Function: createContainer()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"createContainer"}),"(",(0,r.jsx)(n.code,{children:"engineId"}),", ",(0,r.jsx)(n.code,{children:"containerCreateOptions"}),"): ",(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,r.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Create a new container on a specific container engine"}),"\n",(0,r.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"engineId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["the id of the engine on which to create the container, obtained from the result of ",(0,r.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"containerCreateOptions"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateOptions",children:(0,r.jsx)(n.code,{children:"ContainerCreateOptions"})})]}),"\n",(0,r.jsx)(n.p,{children:"the details of the container to create"}),"\n",(0,r.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"})," <",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerCreateResult",children:(0,r.jsx)(n.code,{children:"ContainerCreateResult"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise resolving to the information on the created container"}),"\n",(0,r.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3215",children:"packages/extension-api/src/extension-api.d.ts:3215"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>s});var r=t(27378);const i={},a=r.createContext(i);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a4794f2e.f73aaf9c.js b/assets/js/a4794f2e.b6359376.js similarity index 97% rename from assets/js/a4794f2e.f73aaf9c.js rename to assets/js/a4794f2e.b6359376.js index 23c777c0aa7..be7a7a74755 100644 --- a/assets/js/a4794f2e.f73aaf9c.js +++ b/assets/js/a4794f2e.b6359376.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{82563:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,t.jsx)(r.code,{children:"registryProvider"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"registryProvider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,t.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L657",children:"packages/extension-api/src/extension-api.d.ts:657"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var t=s(27378);const i={},n=t.createContext(i);function o(e){const r=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{82563:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const n={},o="Function: registerRegistryProvider()",c={id:"namespaces/registry/functions/registerRegistryProvider",title:"Function: registerRegistryProvider()",description:"registerRegistryProvider(registryProvider): Disposable",source:"@site/api/namespaces/registry/functions/registerRegistryProvider.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/registerRegistryProvider",permalink:"/api/namespaces/registry/functions/registerRegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"},next:{title:"suggestRegistry",permalink:"/api/namespaces/registry/functions/suggestRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerregistryprovider",children:"Function: registerRegistryProvider()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerRegistryProvider"}),"(",(0,t.jsx)(r.code,{children:"registryProvider"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"registryProvider"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/RegistryProvider",children:(0,t.jsx)(r.code,{children:"RegistryProvider"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L657",children:"packages/extension-api/src/extension-api.d.ts:657"})})]})}function p(e={}){const{wrapper:r}={...(0,i.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>c,a:()=>o});var t=s(27378);const i={},n=t.createContext(i);function o(e){const r=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a9fa5b1f.6f29da5e.js b/assets/js/a9fa5b1f.0f426e7b.js similarity index 80% rename from assets/js/a9fa5b1f.6f29da5e.js rename to assets/js/a9fa5b1f.0f426e7b.js index 5dee2227d68..ffabcd6c739 100644 --- a/assets/js/a9fa5b1f.6f29da5e.js +++ b/assets/js/a9fa5b1f.0f426e7b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{12816:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=r(24246),i=r(71670);const s={},o="Interface: ProviderCleanupAction",c={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,t.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L453",children:"packages/extension-api/src/extension-api.d.ts:453"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var t=r(27378);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{12816:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(24246),i=r(71670);const s={},c="Interface: ProviderCleanupAction",o={id:"interfaces/ProviderCleanupAction",title:"Interface: ProviderCleanupAction",description:"Properties",source:"@site/api/interfaces/ProviderCleanupAction.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderCleanupAction",permalink:"/api/interfaces/ProviderCleanupAction",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"},next:{title:"ProviderCleanupExecuteOptions",permalink:"/api/interfaces/ProviderCleanupExecuteOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-providercleanupaction",children:"Interface: ProviderCleanupAction"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"name"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(",(0,t.jsx)(n.code,{children:"options"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProviderCleanupExecuteOptions",children:(0,t.jsx)(n.code,{children:"ProviderCleanupExecuteOptions"})})]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L453",children:"packages/extension-api/src/extension-api.d.ts:453"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var t=r(27378);const i={},s=t.createContext(i);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab69fe56.e0a4c1ca.js b/assets/js/ab69fe56.9dc7f07d.js similarity index 97% rename from assets/js/ab69fe56.e0a4c1ca.js rename to assets/js/ab69fe56.9dc7f07d.js index 1ba68c8059f..c142568d579 100644 --- a/assets/js/ab69fe56.e0a4c1ca.js +++ b/assets/js/ab69fe56.9dc7f07d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{85297:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var o=t(24246),s=t(71670);const i={},a="Type alias: MountConfig",r={id:"type-aliases/MountConfig",title:"Type alias: MountConfig",description:"MountConfig: MountSettings[]",source:"@site/api/type-aliases/MountConfig.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConfig",permalink:"/api/type-aliases/MountConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},u=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2157",children:"packages/extension-api/src/extension-api.d.ts:2157"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{85297:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var o=t(24246),s=t(71670);const i={},a="Type alias: MountConfig",r={id:"type-aliases/MountConfig",title:"Type alias: MountConfig",description:"MountConfig: MountSettings[]",source:"@site/api/type-aliases/MountConfig.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountConfig",permalink:"/api/type-aliases/MountConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"},next:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"}},c={},u=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"type-alias-mountconfig",children:"Type alias: MountConfig"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"MountConfig"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/MountSettings",children:(0,o.jsx)(n.code,{children:"MountSettings"})}),"[]"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2157",children:"packages/extension-api/src/extension-api.d.ts:2157"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/adcef0a2.cc79f157.js b/assets/js/adcef0a2.46f76829.js similarity index 85% rename from assets/js/adcef0a2.cc79f157.js rename to assets/js/adcef0a2.46f76829.js index a0329428601..fb2508de067 100644 --- a/assets/js/adcef0a2.cc79f157.js +++ b/assets/js/adcef0a2.46f76829.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{55068:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var c=n(24246),t=n(71670);const a={},i="Interface: ImageCheckerProvider",s={id:"interfaces/ImageCheckerProvider",title:"Interface: ImageCheckerProvider",description:"Interface to be implemented by image checker providers",source:"@site/api/interfaces/ImageCheckerProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheck",permalink:"/api/interfaces/ImageCheck"},next:{title:"ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"}},o={},d=[{value:"Methods",id:"methods",level:2},{value:"check()",id:"check",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"}),"\n",(0,c.jsx)(r.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,c.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(r.h3,{id:"check",children:"check()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"check"}),"(",(0,c.jsx)(r.code,{children:"image"}),", ",(0,c.jsx)(r.code,{children:"token"}),"?): ",(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})})," <",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})}),">"]}),"\n"]}),"\n",(0,c.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"image"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageInfo",children:(0,c.jsx)(r.code,{children:"ImageInfo"})})]}),"\n",(0,c.jsx)(r.p,{children:"Info about the image to analyze"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"token?"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(r.code,{children:"CancellationToken"})})]}),"\n",(0,c.jsx)(r.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,c.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})})," <",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})}),">"]}),"\n",(0,c.jsx)(r.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,c.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(r.p,{children:(0,c.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4149",children:"packages/extension-api/src/extension-api.d.ts:4149"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>s,a:()=>i});var c=n(27378);const t={},a=c.createContext(t);function i(e){const r=c.useContext(a);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),c.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{55068:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>s,default:()=>l,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var c=n(24246),t=n(71670);const i={},s="Interface: ImageCheckerProvider",a={id:"interfaces/ImageCheckerProvider",title:"Interface: ImageCheckerProvider",description:"Interface to be implemented by image checker providers",source:"@site/api/interfaces/ImageCheckerProvider.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheck",permalink:"/api/interfaces/ImageCheck"},next:{title:"ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata"}},o={},d=[{value:"Methods",id:"methods",level:2},{value:"check()",id:"check",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function h(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.h1,{id:"interface-imagecheckerprovider",children:"Interface: ImageCheckerProvider"}),"\n",(0,c.jsx)(r.p,{children:"Interface to be implemented by image checker providers"}),"\n",(0,c.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(r.h3,{id:"check",children:"check()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"check"}),"(",(0,c.jsx)(r.code,{children:"image"}),", ",(0,c.jsx)(r.code,{children:"token"}),"?): ",(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})})," <",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})}),">"]}),"\n"]}),"\n",(0,c.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"image"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageInfo",children:(0,c.jsx)(r.code,{children:"ImageInfo"})})]}),"\n",(0,c.jsx)(r.p,{children:"Info about the image to analyze"}),"\n",(0,c.jsxs)(r.p,{children:["\u2022 ",(0,c.jsx)(r.strong,{children:"token?"}),": ",(0,c.jsx)(r.a,{href:"/api/interfaces/CancellationToken",children:(0,c.jsx)(r.code,{children:"CancellationToken"})})]}),"\n",(0,c.jsx)(r.p,{children:"a cancellation token the function can use to be informed when the caller asks for the operation to be cancelled"}),"\n",(0,c.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/api/type-aliases/ProviderResult",children:(0,c.jsx)(r.code,{children:"ProviderResult"})})," <",(0,c.jsx)(r.a,{href:"/api/interfaces/ImageChecks",children:(0,c.jsx)(r.code,{children:"ImageChecks"})}),">"]}),"\n",(0,c.jsx)(r.p,{children:"the complete result of the analyze, either synchronously of through a Promise"}),"\n",(0,c.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(r.p,{children:(0,c.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4149",children:"packages/extension-api/src/extension-api.d.ts:4149"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>s});var c=n(27378);const t={},i=c.createContext(t);function s(e){const r=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),c.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/adfdec4a.ab8d6370.js b/assets/js/adfdec4a.2b0d8ff3.js similarity index 86% rename from assets/js/adfdec4a.ab8d6370.js rename to assets/js/adfdec4a.2b0d8ff3.js index 43e01b232e4..f92d4eadf96 100644 --- a/assets/js/adfdec4a.ab8d6370.js +++ b/assets/js/adfdec4a.2b0d8ff3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{28305:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var i=s(24246),c=s(71670);const t={},o="Interface: CustomPick",d={id:"interfaces/CustomPick",title:"Interface: CustomPick\\",description:"A concrete CustomPick to let the user pick an item from a list of items of type T.",source:"@site/api/interfaces/CustomPick.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPick",permalink:"/api/interfaces/CustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"},next:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"}},r={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Source",id:"source",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Source",id:"source-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-3",level:4},{value:"items",id:"items",level:3},{value:"Source",id:"source-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Source",id:"source-7",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-11",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"}),"\n",(0,i.jsx)(n.p,{children:"A concrete CustomPick to let the user pick an item from a list of items of type T.\nThe items are rendered using a custom UI."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,i.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1151",children:"packages/extension-api/src/extension-api.d.ts:1151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1139",children:"packages/extension-api/src/extension-api.d.ts:1139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the additional sections of an item should be hidden by default when the dialog opens up.\nThe user can still open them by clicking on the 'show more' button.\nDefaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1157",children:"packages/extension-api/src/extension-api.d.ts:1157"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1143",children:"packages/extension-api/src/extension-api.d.ts:1143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"minHeight"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"When a custompick is closed (the sections are hidden) it is possible to set a minimum height so to force different items to have the same height.\nIt must be set using pixels or percentage (e.g 100px or 50%)\nUse it carefully as it could break the layout."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1163",children:"packages/extension-api/src/extension-api.d.ts:1163"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidConfirmSelection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"number"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1167",children:"packages/extension-api/src/extension-api.d.ts:1167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidHide"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1171",children:"packages/extension-api/src/extension-api.d.ts:1171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1135",children:"packages/extension-api/src/extension-api.d.ts:1135"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1185",children:"packages/extension-api/src/extension-api.d.ts:1185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1179",children:"packages/extension-api/src/extension-api.d.ts:1179"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},t=i.createContext(c);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{28305:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>a,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(24246),c=s(71670);const t={},o="Interface: CustomPick",r={id:"interfaces/CustomPick",title:"Interface: CustomPick\\",description:"A concrete CustomPick to let the user pick an item from a list of items of type T.",source:"@site/api/interfaces/CustomPick.md",sourceDirName:"interfaces",slug:"/interfaces/CustomPick",permalink:"/api/interfaces/CustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"},next:{title:"CustomPickItem",permalink:"/api/interfaces/CustomPickItem"}},d={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"canSelectMany",id:"canselectmany",level:3},{value:"Source",id:"source",level:4},{value:"description?",id:"description",level:3},{value:"Source",id:"source-1",level:4},{value:"hideItemSections",id:"hideitemsections",level:3},{value:"Source",id:"source-2",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-3",level:4},{value:"items",id:"items",level:3},{value:"Source",id:"source-4",level:4},{value:"minHeight?",id:"minheight",level:3},{value:"Source",id:"source-5",level:4},{value:"onDidConfirmSelection",id:"ondidconfirmselection",level:3},{value:"Source",id:"source-6",level:4},{value:"onDidHide",id:"ondidhide",level:3},{value:"Source",id:"source-7",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-8",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-9",level:4},{value:"hide()",id:"hide",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-10",level:4},{value:"show()",id:"show",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-11",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-custompickt",children:"Interface: CustomPick"}),"\n",(0,i.jsx)(n.p,{children:"A concrete CustomPick to let the user pick an item from a list of items of type T.\nThe items are rendered using a custom UI."}),"\n",(0,i.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})," ",(0,i.jsx)(n.em,{children:"extends"})," ",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPickItem",children:(0,i.jsx)(n.code,{children:"CustomPickItem"})})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"canselectmany",children:"canSelectMany"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"canSelectMany"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If multiple items can be selected at the same time. Defaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1151",children:"packages/extension-api/src/extension-api.d.ts:1151"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"description"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered less prominent in a separate line."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1139",children:"packages/extension-api/src/extension-api.d.ts:1139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hideitemsections",children:"hideItemSections"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hideItemSections"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If the additional sections of an item should be hidden by default when the dialog opens up.\nThe user can still open them by clicking on the 'show more' button.\nDefaults to false."}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1157",children:"packages/extension-api/src/extension-api.d.ts:1157"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"icon"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional base64 PNG image"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1143",children:"packages/extension-api/src/extension-api.d.ts:1143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"items",children:"items"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"T"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Items to pick from. This can be read and updated by the extension."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1147",children:"packages/extension-api/src/extension-api.d.ts:1147"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"minheight",children:"minHeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"minHeight"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"When a custompick is closed (the sections are hidden) it is possible to set a minimum height so to force different items to have the same height.\nIt must be set using pixels or percentage (e.g 100px or 50%)\nUse it carefully as it could break the layout."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1163",children:"packages/extension-api/src/extension-api.d.ts:1163"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidconfirmselection",children:"onDidConfirmSelection"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidConfirmSelection"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"number"}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when the user indicated confirmation of the selected item(s) index(es)."}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1167",children:"packages/extension-api/src/extension-api.d.ts:1167"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ondidhide",children:"onDidHide"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"onDidHide"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(n.code,{children:"Event"})}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An event signaling when this input UI is hidden."}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1171",children:"packages/extension-api/src/extension-api.d.ts:1171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"An optional human-readable string which is rendered prominent."}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1135",children:"packages/extension-api/src/extension-api.d.ts:1135"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"dispose"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Dispose and free associated resources. Call\n",(0,i.jsx)(n.a,{href:"/api/interfaces/CustomPick#hide",children:"CustomPick.hide"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1185",children:"packages/extension-api/src/extension-api.d.ts:1185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hide",children:"hide()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"hide"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Hides the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1179",children:"packages/extension-api/src/extension-api.d.ts:1179"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"show",children:"show()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"show"}),"(): ",(0,i.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Shows the custom pick."}),"\n",(0,i.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1175",children:"packages/extension-api/src/extension-api.d.ts:1175"})})]})}function a(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var i=s(27378);const c={},t=i.createContext(c);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ae4a775b.b4095719.js b/assets/js/ae4a775b.9903705b.js similarity index 82% rename from assets/js/ae4a775b.b4095719.js rename to assets/js/ae4a775b.9903705b.js index f693fd2e7b0..0a819074ed8 100644 --- a/assets/js/ae4a775b.b4095719.js +++ b/assets/js/ae4a775b.9903705b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{86001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(24246),c=t(71670);const o={},a="Function: setValue()",r={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: context",permalink:"/api/namespaces/context/"},next:{title:"Namespace: env",permalink:"/api/namespaces/env/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4031",children:"packages/extension-api/src/extension-api.d.ts:4031"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var s=t(27378);const c={},o=s.createContext(c);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{86001:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=t(24246),c=t(71670);const o={},r="Function: setValue()",a={id:"namespaces/context/functions/setValue",title:"Function: setValue()",description:"setValue(key, value, scope?): void",source:"@site/api/namespaces/context/functions/setValue.md",sourceDirName:"namespaces/context/functions",slug:"/namespaces/context/functions/setValue",permalink:"/api/namespaces/context/functions/setValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: context",permalink:"/api/namespaces/context/"},next:{title:"Namespace: env",permalink:"/api/namespaces/env/"}},i={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-setvalue",children:"Function: setValue()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"setValue"}),"(",(0,s.jsx)(n.code,{children:"key"}),", ",(0,s.jsx)(n.code,{children:"value"}),", ",(0,s.jsx)(n.code,{children:"scope"}),"?): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:'Store a new value for key in the context.\nThis can be used in enablement of command or with the when property.\nThe key should consists of \'"extension-id"."actual-key"\'.'}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"key"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the key of the key/value pair to be added to the context"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"value"}),": ",(0,s.jsx)(n.code,{children:"any"})]}),"\n",(0,s.jsx)(n.p,{children:"value associated to the key"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"scope?"}),": ",(0,s.jsx)(n.code,{children:'"onboarding"'})]}),"\n",(0,s.jsx)(n.p,{children:"the scope to use to save the value"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4031",children:"packages/extension-api/src/extension-api.d.ts:4031"})})]})}function u(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>r});var s=t(27378);const c={},o=s.createContext(c);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b15eeff9.ad75358f.js b/assets/js/b15eeff9.ebc411c4.js similarity index 94% rename from assets/js/b15eeff9.ad75358f.js rename to assets/js/b15eeff9.ebc411c4.js index 9e195258699..1ed5c67e719 100644 --- a/assets/js/b15eeff9.ad75358f.js +++ b/assets/js/b15eeff9.ebc411c4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(24246),o=t(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",a={id:"interfaces/AuthenticationSessionAccountInformation",title:"Interface: AuthenticationSessionAccountInformation",description:"The information of an account associated with an AuthenticationSession.",source:"@site/api/interfaces/AuthenticationSessionAccountInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},r={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"}),"\n",(0,i.jsxs)(n.p,{children:["The information of an account associated with an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3462",children:"packages/extension-api/src/extension-api.d.ts:3462"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3467",children:"packages/extension-api/src/extension-api.d.ts:3467"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const o={},s=i.createContext(o);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{9958:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var i=t(24246),o=t(71670);const s={},c="Interface: AuthenticationSessionAccountInformation",a={id:"interfaces/AuthenticationSessionAccountInformation",title:"Interface: AuthenticationSessionAccountInformation",description:"The information of an account associated with an AuthenticationSession.",source:"@site/api/interfaces/AuthenticationSessionAccountInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationSessionAccountInformation",permalink:"/api/interfaces/AuthenticationSessionAccountInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationSession",permalink:"/api/interfaces/AuthenticationSession"},next:{title:"AuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationSessionsChangeEvent"}},r={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationsessionaccountinformation",children:"Interface: AuthenticationSessionAccountInformation"}),"\n",(0,i.jsxs)(n.p,{children:["The information of an account associated with an ",(0,i.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3462",children:"packages/extension-api/src/extension-api.d.ts:3462"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the account."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3467",children:"packages/extension-api/src/extension-api.d.ts:3467"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>c});var i=t(27378);const o={},s=i.createContext(o);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b3b7dd16.5a298e87.js b/assets/js/b3b7dd16.a26b9658.js similarity index 97% rename from assets/js/b3b7dd16.5a298e87.js rename to assets/js/b3b7dd16.a26b9658.js index 5d892d6e84c..640ced740d2 100644 --- a/assets/js/b3b7dd16.5a298e87.js +++ b/assets/js/b3b7dd16.a26b9658.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{58966:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var s=n(24246),c=n(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: window",permalink:"/api/namespaces/window/"},next:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},u=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(t.code,{children:"T"}),">(): ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"<",(0,s.jsx)(t.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Creates a CustomPick to let the user pick an item from a list of items of type T using a custom UI."}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"T"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(t.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"<",(0,s.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(t.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1822",children:"packages/extension-api/src/extension-api.d.ts:1822"})})]})}function p(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(27378);const c={},i=s.createContext(c);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{58966:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var s=n(24246),c=n(71670);const i={},o="Function: createCustomPick()",r={id:"namespaces/window/functions/createCustomPick",title:"Function: createCustomPick()",description:"createCustomPick\\(): CustomPick\\",source:"@site/api/namespaces/window/functions/createCustomPick.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: window",permalink:"/api/namespaces/window/"},next:{title:"createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem"}},a={},u=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"function-createcustompick",children:"Function: createCustomPick()"}),"\n",(0,s.jsxs)(t.blockquote,{children:["\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"createCustomPick"}),"<",(0,s.jsx)(t.code,{children:"T"}),">(): ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"<",(0,s.jsx)(t.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Creates a CustomPick to let the user pick an item from a list of items of type T using a custom UI."}),"\n",(0,s.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,s.jsxs)(t.p,{children:["\u2022 ",(0,s.jsx)(t.strong,{children:"T"})," ",(0,s.jsx)(t.em,{children:"extends"})," ",(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPickItem",children:(0,s.jsx)(t.code,{children:"CustomPickItem"})})]}),"\n",(0,s.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.a,{href:"/api/interfaces/CustomPick",children:(0,s.jsx)(t.code,{children:"CustomPick"})}),"<",(0,s.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,s.jsx)(t.p,{children:"A new CustomPick"}),"\n",(0,s.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1822",children:"packages/extension-api/src/extension-api.d.ts:1822"})})]})}function p(e={}){const{wrapper:t}={...(0,c.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>r,a:()=>o});var s=n(27378);const c={},i=s.createContext(c);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b4df9b48.91bceb78.js b/assets/js/b4df9b48.8dc64818.js similarity index 86% rename from assets/js/b4df9b48.91bceb78.js rename to assets/js/b4df9b48.8dc64818.js index 597052e091f..96f7da41a7c 100644 --- a/assets/js/b4df9b48.91bceb78.js +++ b/assets/js/b4df9b48.8dc64818.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{16463:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>a});var r=s(24246),i=s(71670);const c={},t="Interface: Registry",d={id:"interfaces/Registry",title:"Interface: Registry",description:"Extends",source:"@site/api/interfaces/Registry.md",sourceDirName:"interfaces",slug:"/interfaces/Registry",permalink:"/api/interfaces/Registry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"},next:{title:"RegistryConfig",permalink:"/api/interfaces/RegistryConfig"}},o={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-1",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-2",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-4",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Source",id:"source-5",level:4},{value:"source",id:"source-6",level:3},{value:"Source",id:"source-7",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registry",children:"Interface: Registry"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"alias",children:"alias?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"alias"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#alias",children:(0,r.jsx)(n.code,{children:"alias"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"icon"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#insecure",children:(0,r.jsx)(n.code,{children:"insecure"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L644",children:"packages/extension-api/src/extension-api.d.ts:644"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#secret",children:(0,r.jsx)(n.code,{children:"secret"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#serverurl",children:(0,r.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"source-6",children:"source"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"source"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L633",children:"packages/extension-api/src/extension-api.d.ts:633"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#username",children:(0,r.jsx)(n.code,{children:"username"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{16463:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var r=s(24246),i=s(71670);const c={},t="Interface: Registry",o={id:"interfaces/Registry",title:"Interface: Registry",description:"Extends",source:"@site/api/interfaces/Registry.md",sourceDirName:"interfaces",slug:"/interfaces/Registry",permalink:"/api/interfaces/Registry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent"},next:{title:"RegistryConfig",permalink:"/api/interfaces/RegistryConfig"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"icon?",id:"icon",level:3},{value:"Source",id:"source-1",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-2",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-3",level:4},{value:"secret",id:"secret",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-4",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Source",id:"source-5",level:4},{value:"source",id:"source-6",level:3},{value:"Source",id:"source-7",level:4},{value:"username",id:"username",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registry",children:"Interface: Registry"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"alias",children:"alias?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"alias"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#alias",children:(0,r.jsx)(n.code,{children:"alias"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"icon",children:"icon?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"icon"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L637",children:"packages/extension-api/src/extension-api.d.ts:637"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#insecure",children:(0,r.jsx)(n.code,{children:"insecure"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L644",children:"packages/extension-api/src/extension-api.d.ts:644"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#secret",children:(0,r.jsx)(n.code,{children:"secret"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#serverurl",children:(0,r.jsx)(n.code,{children:"serverUrl"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"source-6",children:"source"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"source"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L633",children:"packages/extension-api/src/extension-api.d.ts:633"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,r.jsx)(n.code,{children:"RegistryCreateOptions"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/RegistryCreateOptions#username",children:(0,r.jsx)(n.code,{children:"username"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5114993.8399e9e2.js b/assets/js/b5114993.02b996d6.js similarity index 87% rename from assets/js/b5114993.8399e9e2.js rename to assets/js/b5114993.02b996d6.js index 0736c0a039d..0fec19d4aff 100644 --- a/assets/js/b5114993.8399e9e2.js +++ b/assets/js/b5114993.02b996d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{28838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>l,metadata:()=>a,toc:()=>o});var i=n(24246),r=n(71670);const l={},c="Class: Disposable",a={id:"classes/Disposable",title:"Class: Disposable",description:"Extended by",source:"@site/api/classes/Disposable.md",sourceDirName:"classes",slug:"/classes/Disposable",permalink:"/api/classes/Disposable",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"},next:{title:"EventEmitter",permalink:"/api/classes/EventEmitter"}},d={},o=[{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Disposable()",id:"new-disposable",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"new Disposable()",id:"new-disposable-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-4",level:4}];function t(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,i.jsx)(s.code,{children:"FileSystemWatcher"})})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/CliTool",children:(0,i.jsx)(s.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(s.h3,{id:"new-disposable",children:"new Disposable()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L85",children:"packages/extension-api/src/extension-api.d.ts:85"})}),"\n",(0,i.jsx)(s.h3,{id:"new-disposable-1",children:"new Disposable()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"callOnDispose"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Creates a new Disposable calling the provided function\non dispose."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"callOnDispose"}),": ",(0,i.jsx)(s.code,{children:"Function"})]}),"\n",(0,i.jsx)(s.p,{children:"Function that disposes something."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L92",children:"packages/extension-api/src/extension-api.d.ts:92"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"create",children:"create()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"static"})," ",(0,i.jsx)(s.strong,{children:"create"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L99",children:"packages/extension-api/src/extension-api.d.ts:99"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"from",children:"from()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"static"})," ",(0,i.jsx)(s.strong,{children:"from"}),"(...",(0,i.jsx)(s.code,{children:"disposableLikes"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Combine many disposable-likes into one. Use this method\nwhen having objects with a dispose function which are not\ninstances of Disposable."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ...",(0,i.jsx)(s.strong,{children:"disposableLikes"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["Objects that have at least a ",(0,i.jsx)(s.code,{children:"dispose"}),"-function member."]}),"\n",(0,i.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"Returns a new disposable which, upon dispose, will\ndispose all provided disposables."}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L111",children:"packages/extension-api/src/extension-api.d.ts:111"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>c});var i=n(27378);const r={},l=i.createContext(r);function c(e){const s=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{28838:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const c={},l="Class: Disposable",o={id:"classes/Disposable",title:"Class: Disposable",description:"Extended by",source:"@site/api/classes/Disposable.md",sourceDirName:"classes",slug:"/classes/Disposable",permalink:"/api/classes/Disposable",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CancellationTokenSource",permalink:"/api/classes/CancellationTokenSource"},next:{title:"EventEmitter",permalink:"/api/classes/EventEmitter"}},a={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new Disposable()",id:"new-disposable",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"new Disposable()",id:"new-disposable-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"dispose()",id:"dispose",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4},{value:"from()",id:"from",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Source",id:"source-4",level:4}];function t(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"class-disposable",children:"Class: Disposable"}),"\n",(0,i.jsx)(s.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/FileSystemWatcher",children:(0,i.jsx)(s.code,{children:"FileSystemWatcher"})})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"/api/interfaces/CliTool",children:(0,i.jsx)(s.code,{children:"CliTool"})})}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(s.h3,{id:"new-disposable",children:"new Disposable()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L85",children:"packages/extension-api/src/extension-api.d.ts:85"})}),"\n",(0,i.jsx)(s.h3,{id:"new-disposable-1",children:"new Disposable()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"new Disposable"}),"(",(0,i.jsx)(s.code,{children:"callOnDispose"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Creates a new Disposable calling the provided function\non dispose."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"callOnDispose"}),": ",(0,i.jsx)(s.code,{children:"Function"})]}),"\n",(0,i.jsx)(s.p,{children:"Function that disposes something."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L92",children:"packages/extension-api/src/extension-api.d.ts:92"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"dispose",children:"dispose()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"dispose"}),"(): ",(0,i.jsx)(s.code,{children:"void"})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Dispose this object."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.code,{children:"void"})}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L97",children:"packages/extension-api/src/extension-api.d.ts:97"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"create",children:"create()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"static"})," ",(0,i.jsx)(s.strong,{children:"create"}),"(",(0,i.jsx)(s.code,{children:"func"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"func"})]}),"\n",(0,i.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L99",children:"packages/extension-api/src/extension-api.d.ts:99"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"from",children:"from()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"static"})," ",(0,i.jsx)(s.strong,{children:"from"}),"(...",(0,i.jsx)(s.code,{children:"disposableLikes"}),"): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Combine many disposable-likes into one. Use this method\nwhen having objects with a dispose function which are not\ninstances of Disposable."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ...",(0,i.jsx)(s.strong,{children:"disposableLikes"}),": ",(0,i.jsx)(s.code,{children:"object"}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["Objects that have at least a ",(0,i.jsx)(s.code,{children:"dispose"}),"-function member."]}),"\n",(0,i.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"Returns a new disposable which, upon dispose, will\ndispose all provided disposables."}),"\n",(0,i.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L111",children:"packages/extension-api/src/extension-api.d.ts:111"})})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>l});var i=n(27378);const r={},c=i.createContext(r);function l(e){const s=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(c.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b51a9aee.4148c4f8.js b/assets/js/b51a9aee.e6e796d5.js similarity index 94% rename from assets/js/b51a9aee.4148c4f8.js rename to assets/js/b51a9aee.e6e796d5.js index e2bac454633..63bac4f6cab 100644 --- a/assets/js/b51a9aee.4148c4f8.js +++ b/assets/js/b51a9aee.e6e796d5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{64690:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolumes()",c={id:"namespaces/navigation/functions/navigateToVolumes",title:"Function: navigateToVolumes()",description:"navigateToVolumes(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolumes.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"},next:{title:"navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4198",children:"packages/extension-api/src/extension-api.d.ts:4198"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{64690:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=t(24246),s=t(71670);const i={},a="Function: navigateToVolumes()",c={id:"namespaces/navigation/functions/navigateToVolumes",title:"Function: navigateToVolumes()",description:"navigateToVolumes(): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToVolumes.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToVolumes",permalink:"/api/namespaces/navigation/functions/navigateToVolumes",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToVolume",permalink:"/api/namespaces/navigation/functions/navigateToVolume"},next:{title:"navigateToWebview",permalink:"/api/namespaces/navigation/functions/navigateToWebview"}},r={},u=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-navigatetovolumes",children:"Function: navigateToVolumes()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"navigateToVolumes"}),"(): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4198",children:"packages/extension-api/src/extension-api.d.ts:4198"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var o=t(27378);const s={},i=o.createContext(s);function a(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b52d840d.57ad3503.js b/assets/js/b52d840d.6ab58abf.js similarity index 82% rename from assets/js/b52d840d.57ad3503.js rename to assets/js/b52d840d.6ab58abf.js index befe0419422..93bc27cd02d 100644 --- a/assets/js/b52d840d.57ad3503.js +++ b/assets/js/b52d840d.6ab58abf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{50816:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: VolumeInfo",d={id:"interfaces/VolumeInfo",title:"Interface: VolumeInfo",description:"Properties",source:"@site/api/interfaces/VolumeInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeInfo",permalink:"/api/interfaces/VolumeInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"},next:{title:"VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Options?",id:"options",level:3},{value:"Source",id:"source-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Source",id:"source-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3137",children:"packages/extension-api/src/extension-api.d.ts:3137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3140",children:"packages/extension-api/src/extension-api.d.ts:3140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3143",children:"packages/extension-api/src/extension-api.d.ts:3143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3139",children:"packages/extension-api/src/extension-api.d.ts:3139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3145",children:"packages/extension-api/src/extension-api.d.ts:3145"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:'"global"'})," | ",(0,i.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3144",children:"packages/extension-api/src/extension-api.d.ts:3144"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3142",children:"packages/extension-api/src/extension-api.d.ts:3142"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UsageData"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"containersUsage"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3138",children:"packages/extension-api/src/extension-api.d.ts:3138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3136",children:"packages/extension-api/src/extension-api.d.ts:3136"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{50816:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: VolumeInfo",t={id:"interfaces/VolumeInfo",title:"Interface: VolumeInfo",description:"Properties",source:"@site/api/interfaces/VolumeInfo.md",sourceDirName:"interfaces",slug:"/interfaces/VolumeInfo",permalink:"/api/interfaces/VolumeInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"VolumeDeleteOptions",permalink:"/api/interfaces/VolumeDeleteOptions"},next:{title:"VolumeListInfo",permalink:"/api/interfaces/VolumeListInfo"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"CreatedAt",id:"createdat",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Labels",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"Mountpoint",id:"mountpoint",level:3},{value:"Source",id:"source-3",level:4},{value:"Name",id:"name",level:3},{value:"Source",id:"source-4",level:4},{value:"Options?",id:"options",level:3},{value:"Source",id:"source-5",level:4},{value:"Scope",id:"scope",level:3},{value:"Source",id:"source-6",level:4},{value:"Status?",id:"status",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-7",level:4},{value:"UsageData?",id:"usagedata",level:3},{value:"Source",id:"source-8",level:4},{value:"containersUsage",id:"containersusage",level:3},{value:"Source",id:"source-9",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-10",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-11",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"CreatedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3137",children:"packages/extension-api/src/extension-api.d.ts:3137"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3140",children:"packages/extension-api/src/extension-api.d.ts:3140"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3143",children:"packages/extension-api/src/extension-api.d.ts:3143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3141",children:"packages/extension-api/src/extension-api.d.ts:3141"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3139",children:"packages/extension-api/src/extension-api.d.ts:3139"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3145",children:"packages/extension-api/src/extension-api.d.ts:3145"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Scope"}),": ",(0,i.jsx)(n.code,{children:'"global"'})," | ",(0,i.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3144",children:"packages/extension-api/src/extension-api.d.ts:3144"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"Status?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3142",children:"packages/extension-api/src/extension-api.d.ts:3142"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UsageData"}),": ",(0,i.jsx)(n.code,{children:"null"})," | ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3146",children:"packages/extension-api/src/extension-api.d.ts:3146"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"containersUsage"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3138",children:"packages/extension-api/src/extension-api.d.ts:3138"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3135",children:"packages/extension-api/src/extension-api.d.ts:3135"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3136",children:"packages/extension-api/src/extension-api.d.ts:3136"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5b19789.f973499e.js b/assets/js/b5b19789.54301ca2.js similarity index 94% rename from assets/js/b5b19789.f973499e.js rename to assets/js/b5b19789.54301ca2.js index 60b8997c761..9de873b8c17 100644 --- a/assets/js/b5b19789.f973499e.js +++ b/assets/js/b5b19789.54301ca2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{92300:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),i=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.code,{children:"const"})," ",(0,a.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,a.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,a.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Aligned to the right side."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1224",children:"packages/extension-api/src/extension-api.d.ts:1224"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(t){const e=a.useContext(r);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{92300:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),i=n(71670);const r={},s="Variable: StatusBarAlignRight",o={id:"variables/StatusBarAlignRight",title:"Variable: StatusBarAlignRight",description:"const StatusBarAlignRight: \"RIGHT\" = 'RIGHT'",source:"@site/api/variables/StatusBarAlignRight.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft"},next:{title:"StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.code,{children:"const"})," ",(0,a.jsx)(e.strong,{children:"StatusBarAlignRight"}),": ",(0,a.jsx)(e.code,{children:'"RIGHT"'})," = ",(0,a.jsx)(e.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Aligned to the right side."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1224",children:"packages/extension-api/src/extension-api.d.ts:1224"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,n)=>{n.d(e,{Z:()=>o,a:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(t){const e=a.useContext(r);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(r.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5ec5208.a8548250.js b/assets/js/b5ec5208.6742a5dc.js similarity index 87% rename from assets/js/b5ec5208.a8548250.js rename to assets/js/b5ec5208.6742a5dc.js index aac73324f5f..ef6226dfe82 100644 --- a/assets/js/b5ec5208.a8548250.js +++ b/assets/js/b5ec5208.6742a5dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{53753:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",d={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"}},c={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L583",children:"packages/extension-api/src/extension-api.d.ts:583"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{53753:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);const t={},o="Function: onDidUpdateProvider()",c={id:"namespaces/provider/functions/onDidUpdateProvider",title:"Function: onDidUpdateProvider()",description:"onDidUpdateProvider(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",sourceDirName:"namespaces/provider/functions",slug:"/namespaces/provider/functions/onDidUpdateProvider",permalink:"/api/namespaces/provider/functions/onDidUpdateProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateKubernetesConnection",permalink:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection"},next:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"}},d={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateprovider",children:"Function: onDidUpdateProvider()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProvider"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L583",children:"packages/extension-api/src/extension-api.d.ts:583"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const r={},t=i.createContext(r);function o(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b66ca8cf.cd994c6a.js b/assets/js/b66ca8cf.65dab99c.js similarity index 98% rename from assets/js/b66ca8cf.cd994c6a.js rename to assets/js/b66ca8cf.65dab99c.js index e89950ce7db..2c8255cc53f 100644 --- a/assets/js/b66ca8cf.cd994c6a.js +++ b/assets/js/b66ca8cf.65dab99c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{35161:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L670",children:"packages/extension-api/src/extension-api.d.ts:670"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{35161:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidUnregisterRegistry()",o={id:"namespaces/registry/functions/onDidUnregisterRegistry",title:"Function: onDidUnregisterRegistry()",description:"onDidUnregisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry"},next:{title:"onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidunregisterregistry",children:"Function: onDidUnregisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUnregisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L670",children:"packages/extension-api/src/extension-api.d.ts:670"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b678a236.12c69428.js b/assets/js/b678a236.6573a0ea.js similarity index 96% rename from assets/js/b678a236.12c69428.js rename to assets/js/b678a236.6573a0ea.js index 4ac7dee71f6..6333a198651 100644 --- a/assets/js/b678a236.12c69428.js +++ b/assets/js/b678a236.6573a0ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{28506:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: stopContainer()",c={id:"namespaces/containerEngine/functions/stopContainer",title:"Function: stopContainer()",description:"stopContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer"},next:{title:"stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3273",children:"packages/extension-api/src/extension-api.d.ts:3273"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{28506:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},r="Function: stopContainer()",c={id:"namespaces/containerEngine/functions/stopContainer",title:"Function: stopContainer()",description:"stopContainer(engineId, id): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"statsContainer",permalink:"/api/namespaces/containerEngine/functions/statsContainer"},next:{title:"stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-stopcontainer",children:"Function: stopContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"stopContainer"}),"(",(0,i.jsx)(e.code,{children:"engineId"}),", ",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Stop an existing container"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the engine managing the container, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["the id of the container on this engine, obtained from the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/listContainers",children:"containerEngine.listContainers"})," or as the result of ",(0,i.jsx)(e.a,{href:"/api/namespaces/containerEngine/functions/createContainer",children:"containerEngine.createContainer"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3273",children:"packages/extension-api/src/extension-api.d.ts:3273"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>r});var i=t(27378);const s={},o=i.createContext(s);function r(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6be2912.c44e7539.js b/assets/js/b6be2912.0b635538.js similarity index 87% rename from assets/js/b6be2912.c44e7539.js rename to assets/js/b6be2912.0b635538.js index cec3c496676..22bc2228cb8 100644 --- a/assets/js/b6be2912.c44e7539.js +++ b/assets/js/b6be2912.0b635538.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{17869:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",a={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1640",children:"packages/extension-api/src/extension-api.d.ts:1640"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{17869:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},r="Function: showWarningMessage()",c={id:"namespaces/window/functions/showWarningMessage",title:"Function: showWarningMessage()",description:"showWarningMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showWarningMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showWarningMessage",permalink:"/api/namespaces/window/functions/showWarningMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showSaveDialog",permalink:"/api/namespaces/window/functions/showSaveDialog"},next:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-showwarningmessage",children:"Function: showWarningMessage()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showWarningMessage"}),"(",(0,i.jsx)(n.code,{children:"message"}),", ...",(0,i.jsx)(n.code,{children:"items"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show a warning message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"The message to show."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ...",(0,i.jsx)(n.strong,{children:"items"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,i.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1640",children:"packages/extension-api/src/extension-api.d.ts:1640"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var i=s(27378);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b6d76a6c.1fdaa45f.js b/assets/js/b6d76a6c.e17b76d0.js similarity index 98% rename from assets/js/b6d76a6c.1fdaa45f.js rename to assets/js/b6d76a6c.e17b76d0.js index 0d7c5a03192..198da8126d7 100644 --- a/assets/js/b6d76a6c.1fdaa45f.js +++ b/assets/js/b6d76a6c.e17b76d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{16327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidStateChange"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{16327:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const a={},r="Function: onDidStateChange()",o={id:"namespaces/proxy/functions/onDidStateChange",title:"Function: onDidStateChange()",description:"onDidStateChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidStateChange.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"},next:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidstatechange",children:"Function: onDidStateChange()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidStateChange"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},a=t.createContext(i);function r(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b7bb2d93.173f3736.js b/assets/js/b7bb2d93.3690e23f.js similarity index 93% rename from assets/js/b7bb2d93.173f3736.js rename to assets/js/b7bb2d93.3690e23f.js index c3a08635e3a..9f24afb3897 100644 --- a/assets/js/b7bb2d93.173f3736.js +++ b/assets/js/b7bb2d93.3690e23f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{29264:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=o(24246),r=o(71670);const s={},i="Enumeration: ProgressLocation",a={id:"enumerations/ProgressLocation",title:"Enumeration: ProgressLocation",description:"A location in the editor at which progress information can be shown. It depends on the",source:"@site/api/enumerations/ProgressLocation.md",sourceDirName:"enumerations",slug:"/enumerations/ProgressLocation",permalink:"/api/enumerations/ProgressLocation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"},next:{title:"QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"APP_ICON",id:"app_icon",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L780",children:"packages/extension-api/src/extension-api.d.ts:780"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"task_widget",children:"TASK_WIDGET"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"TASK_WIDGET"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress in the task manager widget"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L785",children:"packages/extension-api/src/extension-api.d.ts:785"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>i});var t=o(27378);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{29264:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=o(24246),r=o(71670);const s={},i="Enumeration: ProgressLocation",a={id:"enumerations/ProgressLocation",title:"Enumeration: ProgressLocation",description:"A location in the editor at which progress information can be shown. It depends on the",source:"@site/api/enumerations/ProgressLocation.md",sourceDirName:"enumerations",slug:"/enumerations/ProgressLocation",permalink:"/api/enumerations/ProgressLocation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity"},next:{title:"QuickPickItemKind",permalink:"/api/enumerations/QuickPickItemKind"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"APP_ICON",id:"app_icon",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"See",id:"see",level:4},{value:"Source",id:"source",level:4},{value:"TASK_WIDGET",id:"task_widget",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"enumeration-progresslocation",children:"Enumeration: ProgressLocation"}),"\n",(0,t.jsx)(n.p,{children:"A location in the editor at which progress information can be shown. It depends on the\nlocation how progress is visually represented."}),"\n",(0,t.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,t.jsx)(n.h3,{id:"app_icon",children:(0,t.jsx)(n.del,{children:"APP_ICON"})}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"APP_ICON"}),": ",(0,t.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress bar under app icon in launcher bar."}),"\n",(0,t.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,t.jsx)(n.p,{children:"This value is deprecated as it does not render equally on various supported platforms. It will be\nremoved in future versions of Podman Desktop. We strongly encourage to use TASK_WIDGET instead."}),"\n",(0,t.jsx)(n.h4,{id:"see",children:"See"}),"\n",(0,t.jsx)(n.p,{children:"TASK_WIDGET"}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L780",children:"packages/extension-api/src/extension-api.d.ts:780"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"task_widget",children:"TASK_WIDGET"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"TASK_WIDGET"}),": ",(0,t.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Show progress in the task manager widget"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L785",children:"packages/extension-api/src/extension-api.d.ts:785"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>i});var t=o(27378);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8eb0fce.1b89060f.js b/assets/js/b8eb0fce.f6979cd2.js similarity index 89% rename from assets/js/b8eb0fce.1b89060f.js rename to assets/js/b8eb0fce.f6979cd2.js index 157ccac8a34..535da3ef8bc 100644 --- a/assets/js/b8eb0fce.1b89060f.js +++ b/assets/js/b8eb0fce.f6979cd2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{81189:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"},next:{title:"onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L668",children:"packages/extension-api/src/extension-api.d.ts:668"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{81189:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>l});var i=n(24246),r=n(71670);const t={},c="Function: onDidRegisterRegistry()",o={id:"namespaces/registry/functions/onDidRegisterRegistry",title:"Function: onDidRegisterRegistry()",description:"onDidRegisterRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidRegisterRegistry",permalink:"/api/namespaces/registry/functions/onDidRegisterRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"},next:{title:"onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidregisterregistry",children:"Function: onDidRegisterRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidRegisterRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L668",children:"packages/extension-api/src/extension-api.d.ts:668"})})]})}function p(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const r={},t=i.createContext(r);function c(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b8ec852b.df1976cd.js b/assets/js/b8ec852b.a1ac7ee7.js similarity index 91% rename from assets/js/b8ec852b.df1976cd.js rename to assets/js/b8ec852b.a1ac7ee7.js index 47d7b663492..109f1de01ca 100644 --- a/assets/js/b8ec852b.df1976cd.js +++ b/assets/js/b8ec852b.a1ac7ee7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{46801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var o=s(24246),r=s(71670);const t={},i="Interface: ProgressOptions",c={id:"interfaces/ProgressOptions",title:"Interface: ProgressOptions",description:"Value-object describing where and how progress should show.",source:"@site/api/interfaces/ProgressOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProgressOptions",permalink:"/api/interfaces/ProgressOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Progress",permalink:"/api/interfaces/Progress"},next:{title:"Provider",permalink:"/api/interfaces/Provider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cancellable?",id:"cancellable",level:3},{value:"Source",id:"source",level:4},{value:"location",id:"location",level:3},{value:"Source",id:"source-1",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"}),"\n",(0,o.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"cancellable"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Controls if a cancel button should show to allow the user to\ncancel the long running operation. Note that currently only\n",(0,o.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L809",children:"packages/extension-api/src/extension-api.d.ts:809"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"location"}),": ",(0,o.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,o.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L795",children:"packages/extension-api/src/extension-api.d.ts:795"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"title"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,o.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L801",children:"packages/extension-api/src/extension-api.d.ts:801"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var o=s(27378);const r={},t=o.createContext(r);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{46801:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var o=s(24246),r=s(71670);const t={},i="Interface: ProgressOptions",c={id:"interfaces/ProgressOptions",title:"Interface: ProgressOptions",description:"Value-object describing where and how progress should show.",source:"@site/api/interfaces/ProgressOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ProgressOptions",permalink:"/api/interfaces/ProgressOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Progress",permalink:"/api/interfaces/Progress"},next:{title:"Provider",permalink:"/api/interfaces/Provider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"cancellable?",id:"cancellable",level:3},{value:"Source",id:"source",level:4},{value:"location",id:"location",level:3},{value:"Source",id:"source-1",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-2",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-progressoptions",children:"Interface: ProgressOptions"}),"\n",(0,o.jsx)(n.p,{children:"Value-object describing where and how progress should show."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"cancellable",children:"cancellable?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"cancellable"}),": ",(0,o.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Controls if a cancel button should show to allow the user to\ncancel the long running operation. Note that currently only\n",(0,o.jsx)(n.code,{children:"ProgressLocation.Notification"})," is supporting to show a cancel\nbutton."]}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L809",children:"packages/extension-api/src/extension-api.d.ts:809"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"location"}),": ",(0,o.jsx)(n.a,{href:"/api/enumerations/ProgressLocation",children:(0,o.jsx)(n.code,{children:"ProgressLocation"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The location at which progress should show."}),"\n",(0,o.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L795",children:"packages/extension-api/src/extension-api.d.ts:795"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.strong,{children:"title"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"A human-readable string which will be used to describe the\noperation."}),"\n",(0,o.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L801",children:"packages/extension-api/src/extension-api.d.ts:801"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>i});var o=s(27378);const r={},t=o.createContext(r);function i(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9287eb6.62bcb562.js b/assets/js/b9287eb6.9af2c247.js similarity index 77% rename from assets/js/b9287eb6.62bcb562.js rename to assets/js/b9287eb6.9af2c247.js index de7eeab1ea7..a6d874d457c 100644 --- a/assets/js/b9287eb6.62bcb562.js +++ b/assets/js/b9287eb6.9af2c247.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{70233:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var r=s(24246),t=s(71670);const i={},c="Interface: CPUUsage",a={id:"interfaces/CPUUsage",title:"Interface: CPUUsage",description:"Properties",source:"@site/api/interfaces/CPUUsage.md",sourceDirName:"interfaces",slug:"/interfaces/CPUUsage",permalink:"/api/interfaces/CPUUsage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CPUStats",permalink:"/api/interfaces/CPUStats"},next:{title:"CancellationToken",permalink:"/api/interfaces/CancellationToken"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Source",id:"source-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Source",id:"source-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2887",children:"packages/extension-api/src/extension-api.d.ts:2887"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"total_usage"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2889",children:"packages/extension-api/src/extension-api.d.ts:2889"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2890",children:"packages/extension-api/src/extension-api.d.ts:2890"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2888",children:"packages/extension-api/src/extension-api.d.ts:2888"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var r=s(27378);const t={},i=r.createContext(t);function c(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{70233:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),t=s(71670);const c={},i="Interface: CPUUsage",o={id:"interfaces/CPUUsage",title:"Interface: CPUUsage",description:"Properties",source:"@site/api/interfaces/CPUUsage.md",sourceDirName:"interfaces",slug:"/interfaces/CPUUsage",permalink:"/api/interfaces/CPUUsage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CPUStats",permalink:"/api/interfaces/CPUStats"},next:{title:"CancellationToken",permalink:"/api/interfaces/CancellationToken"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"percpu_usage",id:"percpu_usage",level:3},{value:"Source",id:"source",level:4},{value:"total_usage",id:"total_usage",level:3},{value:"Source",id:"source-1",level:4},{value:"usage_in_kernelmode",id:"usage_in_kernelmode",level:3},{value:"Source",id:"source-2",level:4},{value:"usage_in_usermode",id:"usage_in_usermode",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2887",children:"packages/extension-api/src/extension-api.d.ts:2887"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"total_usage"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2889",children:"packages/extension-api/src/extension-api.d.ts:2889"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2890",children:"packages/extension-api/src/extension-api.d.ts:2890"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2888",children:"packages/extension-api/src/extension-api.d.ts:2888"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var r=s(27378);const t={},c=r.createContext(t);function i(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9a87183.95b46187.js b/assets/js/b9a87183.62676c9b.js similarity index 92% rename from assets/js/b9a87183.95b46187.js rename to assets/js/b9a87183.62676c9b.js index 95038f9e515..6004201f98d 100644 --- a/assets/js/b9a87183.95b46187.js +++ b/assets/js/b9a87183.62676c9b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{76346:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const o={},a="Interface: AuthenticationProviderInformation",c={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"}),"\n",(0,i.jsxs)(n.p,{children:["Basic information about an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3532",children:"packages/extension-api/src/extension-api.d.ts:3532"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3537",children:"packages/extension-api/src/extension-api.d.ts:3537"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var i=t(27378);const r={},o=i.createContext(r);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{76346:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const o={},a="Interface: AuthenticationProviderInformation",c={id:"interfaces/AuthenticationProviderInformation",title:"Interface: AuthenticationProviderInformation",description:"Basic information about an authenticationProvider",source:"@site/api/interfaces/AuthenticationProviderInformation.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProviderInformation",permalink:"/api/interfaces/AuthenticationProviderInformation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"},next:{title:"AuthenticationProviderOptions",permalink:"/api/interfaces/AuthenticationProviderOptions"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Source",id:"source",level:4},{value:"label",id:"label",level:3},{value:"Source",id:"source-1",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-authenticationproviderinformation",children:"Interface: AuthenticationProviderInformation"}),"\n",(0,i.jsxs)(n.p,{children:["Basic information about an ",(0,i.jsx)(n.a,{href:"#AuthenticationProvider",children:"authenticationProvider"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The unique identifier of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3532",children:"packages/extension-api/src/extension-api.d.ts:3532"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"label",children:"label"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The human-readable name of the authentication provider."}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3537",children:"packages/extension-api/src/extension-api.d.ts:3537"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var i=t(27378);const r={},o=i.createContext(r);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bab44fba.4e1dd157.js b/assets/js/bab44fba.32f48154.js similarity index 98% rename from assets/js/bab44fba.4e1dd157.js rename to assets/js/bab44fba.32f48154.js index adf7521e010..2579b5e4172 100644 --- a/assets/js/bab44fba.4e1dd157.js +++ b/assets/js/bab44fba.32f48154.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{23989:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=r(24246),i=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,s.jsx)(n.code,{children:"source"}),", ",(0,s.jsx)(n.code,{children:"target"}),", ",(0,s.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,s.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Warnings"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3414",children:"packages/extension-api/src/extension-api.d.ts:3414"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{23989:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var s=r(24246),i=r(71670);const t={},c="Function: replicatePodmanContainer()",o={id:"namespaces/containerEngine/functions/replicatePodmanContainer",title:"Function: replicatePodmanContainer()",description:"replicatePodmanContainer(source, target, overrideParameters): Promise\\",source:"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"removePod",permalink:"/api/namespaces/containerEngine/functions/removePod"},next:{title:"saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"Warnings",id:"warnings",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-replicatepodmancontainer",children:"Function: replicatePodmanContainer()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"replicatePodmanContainer"}),"(",(0,s.jsx)(n.code,{children:"source"}),", ",(0,s.jsx)(n.code,{children:"target"}),", ",(0,s.jsx)(n.code,{children:"overrideParameters"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"source.id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"target.engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"overrideParameters"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodmanContainerCreateOptions",children:(0,s.jsx)(n.code,{children:"PodmanContainerCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"warnings",children:"Warnings"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Warnings"}),": ",(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3414",children:"packages/extension-api/src/extension-api.d.ts:3414"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bb6a5560.9e014dcf.js b/assets/js/bb6a5560.9071d74c.js similarity index 95% rename from assets/js/bb6a5560.9e014dcf.js rename to assets/js/bb6a5560.9071d74c.js index c97b90c3ff8..2fbb5cb596c 100644 --- a/assets/js/bb6a5560.9e014dcf.js +++ b/assets/js/bb6a5560.9071d74c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{17275:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),o=t(71670);const r={},i="Function: getProxySettings()",c={id:"namespaces/proxy/functions/getProxySettings",title:"Function: getProxySettings()",description:"getProxySettings(): ProxySettings \\| undefined",source:"@site/api/namespaces/proxy/functions/getProxySettings.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"},next:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L611",children:"packages/extension-api/src/extension-api.d.ts:611"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{17275:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(24246),o=t(71670);const r={},i="Function: getProxySettings()",c={id:"namespaces/proxy/functions/getProxySettings",title:"Function: getProxySettings()",description:"getProxySettings(): ProxySettings \\| undefined",source:"@site/api/namespaces/proxy/functions/getProxySettings.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/getProxySettings",permalink:"/api/namespaces/proxy/functions/getProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: proxy",permalink:"/api/namespaces/proxy/"},next:{title:"isEnabled",permalink:"/api/namespaces/proxy/functions/isEnabled"}},a={},d=[{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-getproxysettings",children:"Function: getProxySettings()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"getProxySettings"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,s.jsx)(n.code,{children:"ProxySettings"})})," | ",(0,s.jsx)(n.code,{children:"undefined"})]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L611",children:"packages/extension-api/src/extension-api.d.ts:611"})})]})}function u(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const o={},r=s.createContext(o);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd45720e.d479a701.js b/assets/js/bd45720e.5a59fcfb.js similarity index 95% rename from assets/js/bd45720e.d479a701.js rename to assets/js/bd45720e.5a59fcfb.js index ca437ca07be..98f539efe0c 100644 --- a/assets/js/bd45720e.d479a701.js +++ b/assets/js/bd45720e.5a59fcfb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{31729:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainer()",r={id:"namespaces/navigation/functions/navigateToContainer",title:"Function: navigateToContainer()",description:"navigateToContainer(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainer.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication"},next:{title:"navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4184",children:"packages/extension-api/src/extension-api.d.ts:4184"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{31729:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainer()",r={id:"namespaces/navigation/functions/navigateToContainer",title:"Function: navigateToContainer()",description:"navigateToContainer(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainer.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainer",permalink:"/api/namespaces/navigation/functions/navigateToContainer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToAuthentication",permalink:"/api/namespaces/navigation/functions/navigateToAuthentication"},next:{title:"navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function u(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetocontainer",children:"Function: navigateToContainer()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToContainer"}),"(",(0,i.jsx)(e.code,{children:"id"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"id"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4184",children:"packages/extension-api/src/extension-api.d.ts:4184"})})]})}function l(n={}){const{wrapper:e}={...(0,a.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var i=t(27378);const a={},o=i.createContext(a);function s(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:s(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bd65ec7e.badb7f4a.js b/assets/js/bd65ec7e.29b762c8.js similarity index 97% rename from assets/js/bd65ec7e.badb7f4a.js rename to assets/js/bd65ec7e.29b762c8.js index 132dcecd552..bb6f32648d8 100644 --- a/assets/js/bd65ec7e.badb7f4a.js +++ b/assets/js/bd65ec7e.29b762c8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{34224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1850",children:"packages/extension-api/src/extension-api.d.ts:1850"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{34224:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>i,toc:()=>u});var t=s(24246),r=s(71670);const c={},o="Function: createResources()",i={id:"namespaces/kubernetes/functions/createResources",title:"Function: createResources()",description:"createResources(context, manifests): Promise\\",source:"@site/api/namespaces/kubernetes/functions/createResources.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/createResources",permalink:"/api/namespaces/kubernetes/functions/createResources",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: kubernetes",permalink:"/api/namespaces/kubernetes/"},next:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-createresources",children:"Function: createResources()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"createResources"}),"(",(0,t.jsx)(n.code,{children:"context"}),", ",(0,t.jsx)(n.code,{children:"manifests"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Create one or several Kubernetes resources on the Kubernetes contenxt."}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"context"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"the Kubernetes context to use"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"manifests"}),": ",(0,t.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,t.jsx)(n.p,{children:"the manifests to create as JSON objects"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1850",children:"packages/extension-api/src/extension-api.d.ts:1850"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>o});var t=s(27378);const r={},c=t.createContext(r);function o(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bdb8b81b.0e5020ba.js b/assets/js/bdb8b81b.d23a92b8.js similarity index 94% rename from assets/js/bdb8b81b.0e5020ba.js rename to assets/js/bdb8b81b.d23a92b8.js index 8e06b79188f..cad357629a4 100644 --- a/assets/js/bdb8b81b.0e5020ba.js +++ b/assets/js/bdb8b81b.d23a92b8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{41761:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: StorageStats",c={id:"interfaces/StorageStats",title:"Interface: StorageStats",description:"Properties",source:"@site/api/interfaces/StorageStats.md",sourceDirName:"interfaces",slug:"/interfaces/StorageStats",permalink:"/api/interfaces/StorageStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarItem",permalink:"/api/interfaces/StatusBarItem"},next:{title:"TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Source",id:"source",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Source",id:"source-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Source",id:"source-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"read_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2821",children:"packages/extension-api/src/extension-api.d.ts:2821"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"read_size_bytes",children:"read_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"read_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2822",children:"packages/extension-api/src/extension-api.d.ts:2822"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"write_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2823",children:"packages/extension-api/src/extension-api.d.ts:2823"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"write_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2824",children:"packages/extension-api/src/extension-api.d.ts:2824"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{41761:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const i={},o="Interface: StorageStats",c={id:"interfaces/StorageStats",title:"Interface: StorageStats",description:"Properties",source:"@site/api/interfaces/StorageStats.md",sourceDirName:"interfaces",slug:"/interfaces/StorageStats",permalink:"/api/interfaces/StorageStats",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarItem",permalink:"/api/interfaces/StatusBarItem"},next:{title:"TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"read_count_normalized?",id:"read_count_normalized",level:3},{value:"Source",id:"source",level:4},{value:"read_size_bytes?",id:"read_size_bytes",level:3},{value:"Source",id:"source-1",level:4},{value:"write_count_normalized?",id:"write_count_normalized",level:3},{value:"Source",id:"source-2",level:4},{value:"write_size_bytes?",id:"write_size_bytes",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-storagestats",children:"Interface: StorageStats"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"read_count_normalized",children:"read_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"read_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2821",children:"packages/extension-api/src/extension-api.d.ts:2821"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"read_size_bytes",children:"read_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"read_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2822",children:"packages/extension-api/src/extension-api.d.ts:2822"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_count_normalized",children:"write_count_normalized?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"write_count_normalized"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2823",children:"packages/extension-api/src/extension-api.d.ts:2823"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"write_size_bytes",children:"write_size_bytes?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"write_size_bytes"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2824",children:"packages/extension-api/src/extension-api.d.ts:2824"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var s=t(27378);const r={},i=s.createContext(r);function o(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/be228752.30e1fa56.js b/assets/js/be228752.30e1fa56.js deleted file mode 100644 index 34b9513b831..00000000000 --- a/assets/js/be228752.30e1fa56.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{6701:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},a="Function: navigateToPod()",c={id:"namespaces/navigation/functions/navigateToPod",title:"Function: navigateToPod()",description:"navigateToPod(kind, name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPod.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"navigateToPod"}),"(",(0,i.jsx)(e.code,{children:"kind"}),", ",(0,i.jsx)(e.code,{children:"name"}),", ",(0,i.jsx)(e.code,{children:"engineId"}),"): ",(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"kind"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"name"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"engineId"}),": ",(0,i.jsx)(e.code,{children:"string"})]}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"}),"<",(0,i.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4205",children:"packages/extension-api/src/extension-api.d.ts:4205"})})]})}function u(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>c,a:()=>a});var i=t(27378);const s={},o=i.createContext(s);function a(n){const e=i.useContext(o);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/be228752.6b0bc52a.js b/assets/js/be228752.6b0bc52a.js new file mode 100644 index 00000000000..ecc1bcc5932 --- /dev/null +++ b/assets/js/be228752.6b0bc52a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{6701:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),s=t(71670);const o={},a="Function: navigateToPod()",c={id:"namespaces/navigation/functions/navigateToPod",title:"Function: navigateToPod()",description:"navigateToPod(kind, name, engineId): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToPod.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToPod",permalink:"/api/namespaces/navigation/functions/navigateToPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToImages",permalink:"/api/namespaces/navigation/functions/navigateToImages"},next:{title:"navigateToPods",permalink:"/api/namespaces/navigation/functions/navigateToPods"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-navigatetopod",children:"Function: navigateToPod()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"navigateToPod"}),"(",(0,i.jsx)(n.code,{children:"kind"}),", ",(0,i.jsx)(n.code,{children:"name"}),", ",(0,i.jsx)(n.code,{children:"engineId"}),"): ",(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"kind"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4205",children:"packages/extension-api/src/extension-api.d.ts:4205"})})]})}function u(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var i=t(27378);const s={},o=i.createContext(s);function a(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bf11c6a2.97ece1e1.js b/assets/js/bf11c6a2.a1773df7.js similarity index 91% rename from assets/js/bf11c6a2.97ece1e1.js rename to assets/js/bf11c6a2.a1773df7.js index 933ea31aa72..88f89b40bcc 100644 --- a/assets/js/bf11c6a2.97ece1e1.js +++ b/assets/js/bf11c6a2.a1773df7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{65495:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const t={},c="Interface: RegistryCreateOptions",o={id:"interfaces/RegistryCreateOptions",title:"Interface: RegistryCreateOptions",description:"Extended by",source:"@site/api/interfaces/RegistryCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryConfig",permalink:"/api/interfaces/RegistryConfig"},next:{title:"RegistryProvider",permalink:"/api/interfaces/RegistryProvider"}},a={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Source",id:"source",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Source",id:"source-1",level:4},{value:"secret",id:"secret",level:3},{value:"Source",id:"source-2",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Source",id:"source-3",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"alias",children:"alias?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"alias"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L644",children:"packages/extension-api/src/extension-api.d.ts:644"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{65495:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const t={},c="Interface: RegistryCreateOptions",o={id:"interfaces/RegistryCreateOptions",title:"Interface: RegistryCreateOptions",description:"Extended by",source:"@site/api/interfaces/RegistryCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryConfig",permalink:"/api/interfaces/RegistryConfig"},next:{title:"RegistryProvider",permalink:"/api/interfaces/RegistryProvider"}},a={},d=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"alias?",id:"alias",level:3},{value:"Source",id:"source",level:4},{value:"insecure?",id:"insecure",level:3},{value:"Source",id:"source-1",level:4},{value:"secret",id:"secret",level:3},{value:"Source",id:"source-2",level:4},{value:"serverUrl",id:"serverurl",level:3},{value:"Source",id:"source-3",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registrycreateoptions",children:"Interface: RegistryCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/Registry",children:(0,r.jsx)(n.code,{children:"Registry"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"alias",children:"alias?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"alias"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L645",children:"packages/extension-api/src/extension-api.d.ts:645"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"insecure",children:"insecure?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"insecure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L644",children:"packages/extension-api/src/extension-api.d.ts:644"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"secret",children:"secret"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"secret"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serverurl",children:"serverUrl"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serverUrl"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L641",children:"packages/extension-api/src/extension-api.d.ts:641"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L642",children:"packages/extension-api/src/extension-api.d.ts:642"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c09ab32f.8c38cc39.js b/assets/js/c09ab32f.5013c25c.js similarity index 97% rename from assets/js/c09ab32f.8c38cc39.js rename to assets/js/c09ab32f.5013c25c.js index 758f1f5af60..63c69705bcb 100644 --- a/assets/js/c09ab32f.8c38cc39.js +++ b/assets/js/c09ab32f.5013c25c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{88610:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),s=n(71670);const r={},i="Variable: StatusBarAlignLeft",o={id:"variables/StatusBarAlignLeft",title:"Variable: StatusBarAlignLeft",description:"const StatusBarAlignLeft: \"LEFT\" = 'LEFT'",source:"@site/api/variables/StatusBarAlignLeft.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"},next:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"}},c={},l=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"const"})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1220",children:"packages/extension-api/src/extension-api.d.ts:1220"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>i});var a=n(27378);const s={},r=a.createContext(s);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{88610:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var a=n(24246),s=n(71670);const r={},i="Variable: StatusBarAlignLeft",o={id:"variables/StatusBarAlignLeft",title:"Variable: StatusBarAlignLeft",description:"const StatusBarAlignLeft: \"LEFT\" = 'LEFT'",source:"@site/api/variables/StatusBarAlignLeft.md",sourceDirName:"variables",slug:"/variables/StatusBarAlignLeft",permalink:"/api/variables/StatusBarAlignLeft",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignment",permalink:"/api/type-aliases/StatusBarAlignment"},next:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"}},c={},l=[{value:"Source",id:"source",level:2}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignleft",children:"Variable: StatusBarAlignLeft"}),"\n",(0,a.jsxs)(t.blockquote,{children:["\n",(0,a.jsxs)(t.p,{children:[(0,a.jsx)(t.code,{children:"const"})," ",(0,a.jsx)(t.strong,{children:"StatusBarAlignLeft"}),": ",(0,a.jsx)(t.code,{children:'"LEFT"'})," = ",(0,a.jsx)(t.code,{children:"'LEFT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the left side."}),"\n",(0,a.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1220",children:"packages/extension-api/src/extension-api.d.ts:1220"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>i});var a=n(27378);const s={},r=a.createContext(s);function i(e){const t=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c104141c.2d4076eb.js b/assets/js/c104141c.82632b0e.js similarity index 95% rename from assets/js/c104141c.2d4076eb.js rename to assets/js/c104141c.82632b0e.js index 76ef94c9825..4fdfd38d410 100644 --- a/assets/js/c104141c.2d4076eb.js +++ b/assets/js/c104141c.82632b0e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{10592:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Provider",permalink:"/api/interfaces/Provider"},next:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},c={},d=[{value:"Methods",id:"methods",level:2},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L433",children:"packages/extension-api/src/extension-api.d.ts:433"})})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>a,a:()=>o});var n=r(27378);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{10592:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var n=r(24246),s=r(71670);const i={},o="Interface: ProviderAutostart",a={id:"interfaces/ProviderAutostart",title:"Interface: ProviderAutostart",description:"By providing this interface, when Podman Desktop is starting",source:"@site/api/interfaces/ProviderAutostart.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderAutostart",permalink:"/api/interfaces/ProviderAutostart",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Provider",permalink:"/api/interfaces/Provider"},next:{title:"ProviderCleanup",permalink:"/api/interfaces/ProviderCleanup"}},c={},d=[{value:"Methods",id:"methods",level:2},{value:"start()",id:"start",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-providerautostart",children:"Interface: ProviderAutostart"}),"\n",(0,n.jsx)(t.p,{children:"By providing this interface, when Podman Desktop is starting\nIt'll start the provider through this interface.\nIt can be turned off/on by the user."}),"\n",(0,n.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(t.h3,{id:"start",children:"start()"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"start"}),"(",(0,n.jsx)(t.code,{children:"logger"}),"): ",(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"logger"}),": ",(0,n.jsx)(t.a,{href:"/api/interfaces/Logger",children:(0,n.jsx)(t.code,{children:"Logger"})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Promise"}),"<",(0,n.jsx)(t.code,{children:"void"}),">"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L433",children:"packages/extension-api/src/extension-api.d.ts:433"})})]})}function h(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>a,a:()=>o});var n=r(27378);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1584a80.196fb016.js b/assets/js/c1584a80.5384d5ed.js similarity index 93% rename from assets/js/c1584a80.196fb016.js rename to assets/js/c1584a80.5384d5ed.js index e866aff346d..fae697f2715 100644 --- a/assets/js/c1584a80.196fb016.js +++ b/assets/js/c1584a80.5384d5ed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{89253:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: Logger",o={id:"interfaces/Logger",title:"Interface: Logger",description:"Methods",source:"@site/api/interfaces/Logger.md",sourceDirName:"interfaces",slug:"/interfaces/Logger",permalink:"/api/interfaces/Logger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"},next:{title:"ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"error()",id:"error",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-logger",children:"Interface: Logger"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"error",children:"error()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"error"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L257",children:"packages/extension-api/src/extension-api.d.ts:257"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"log"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L255",children:"packages/extension-api/src/extension-api.d.ts:255"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"warn",children:"warn()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"warn"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L259",children:"packages/extension-api/src/extension-api.d.ts:259"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{89253:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: Logger",o={id:"interfaces/Logger",title:"Interface: Logger",description:"Methods",source:"@site/api/interfaces/Logger.md",sourceDirName:"interfaces",slug:"/interfaces/Logger",permalink:"/api/interfaces/Logger",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"},next:{title:"ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"}},d={},a=[{value:"Methods",id:"methods",level:2},{value:"error()",id:"error",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"log()",id:"log",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"warn()",id:"warn",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-logger",children:"Interface: Logger"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"error",children:"error()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"error"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L257",children:"packages/extension-api/src/extension-api.d.ts:257"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"log",children:"log()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"log"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L255",children:"packages/extension-api/src/extension-api.d.ts:255"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"warn",children:"warn()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"warn"}),"(...",(0,s.jsx)(n.code,{children:"data"}),"): ",(0,s.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ...",(0,s.jsx)(n.strong,{children:"data"}),": ",(0,s.jsx)(n.code,{children:"any"}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L259",children:"packages/extension-api/src/extension-api.d.ts:259"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ca9e21.26400bea.js b/assets/js/c1ca9e21.26400bea.js deleted file mode 100644 index 1710873b138..00000000000 --- a/assets/js/c1ca9e21.26400bea.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{74783:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var i=t(24246),c=t(71670);const r={},o="Interface: KubeconfigUpdateEvent",s={id:"interfaces/KubeconfigUpdateEvent",title:"Interface: KubeconfigUpdateEvent",description:"An event describing the update in kubeconfig location",source:"@site/api/interfaces/KubeconfigUpdateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InstallCheck",permalink:"/api/interfaces/InstallCheck"},next:{title:"KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"location",id:"location",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,i.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"location"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Uri",children:(0,i.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1864",children:"packages/extension-api/src/extension-api.d.ts:1864"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"readonly"})," ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:'"CREATE"'})," | ",(0,i.jsx)(n.code,{children:'"UPDATE"'})," | ",(0,i.jsx)(n.code,{children:'"DELETE"'})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ca9e21.d79fcc4e.js b/assets/js/c1ca9e21.d79fcc4e.js new file mode 100644 index 00000000000..b8447e2b019 --- /dev/null +++ b/assets/js/c1ca9e21.d79fcc4e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{74783:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var c=t(24246),i=t(71670);const r={},o="Interface: KubeconfigUpdateEvent",s={id:"interfaces/KubeconfigUpdateEvent",title:"Interface: KubeconfigUpdateEvent",description:"An event describing the update in kubeconfig location",source:"@site/api/interfaces/KubeconfigUpdateEvent.md",sourceDirName:"interfaces",slug:"/interfaces/KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InstallCheck",permalink:"/api/interfaces/InstallCheck"},next:{title:"KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"location",id:"location",level:3},{value:"Source",id:"source",level:4},{value:"type",id:"type",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-kubeconfigupdateevent",children:"Interface: KubeconfigUpdateEvent"}),"\n",(0,c.jsx)(n.p,{children:"An event describing the update in kubeconfig location"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"location",children:"location"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"readonly"})," ",(0,c.jsx)(n.strong,{children:"location"}),": ",(0,c.jsx)(n.a,{href:"/api/classes/Uri",children:(0,c.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1864",children:"packages/extension-api/src/extension-api.d.ts:1864"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"type",children:"type"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"readonly"})," ",(0,c.jsx)(n.strong,{children:"type"}),": ",(0,c.jsx)(n.code,{children:'"CREATE"'})," | ",(0,c.jsx)(n.code,{children:'"UPDATE"'})," | ",(0,c.jsx)(n.code,{children:'"DELETE"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1863",children:"packages/extension-api/src/extension-api.d.ts:1863"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var c=t(27378);const i={},r=c.createContext(i);function o(e){const n=c.useContext(r);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),c.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c239db97.13ef664e.js b/assets/js/c239db97.ce42ca48.js similarity index 96% rename from assets/js/c239db97.13ef664e.js rename to assets/js/c239db97.ce42ca48.js index ecd78296cd5..71e0e093bf5 100644 --- a/assets/js/c239db97.13ef664e.js +++ b/assets/js/c239db97.ce42ca48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{95783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: saveImage()",c={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3303",children:"packages/extension-api/src/extension-api.d.ts:3303"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{95783:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=i(24246),t=i(71670);const a={},r="Function: saveImage()",c={id:"namespaces/containerEngine/functions/saveImage",title:"Function: saveImage()",description:"saveImage(engineId, id, filename): Promise\\",source:"@site/api/namespaces/containerEngine/functions/saveImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/saveImage",permalink:"/api/namespaces/containerEngine/functions/saveImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"replicatePodmanContainer",permalink:"/api/namespaces/containerEngine/functions/replicatePodmanContainer"},next:{title:"startContainer",permalink:"/api/namespaces/containerEngine/functions/startContainer"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-saveimage",children:"Function: saveImage()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"saveImage"}),"(",(0,s.jsx)(n.code,{children:"engineId"}),", ",(0,s.jsx)(n.code,{children:"id"}),", ",(0,s.jsx)(n.code,{children:"filename"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Save on disk a tarball containing the image and its metadata."}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsxs)(n.p,{children:["the id or name of the image on this engine, obtained from the result of ",(0,s.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"filename"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"the file on which to save the container image content"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3303",children:"packages/extension-api/src/extension-api.d.ts:3303"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const t={},a=s.createContext(t);function r(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c25913f3.bc66943f.js b/assets/js/c25913f3.7bc9c833.js similarity index 88% rename from assets/js/c25913f3.bc66943f.js rename to assets/js/c25913f3.7bc9c833.js index a946a230c9a..1936b247832 100644 --- a/assets/js/c25913f3.bc66943f.js +++ b/assets/js/c25913f3.7bc9c833.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{4069:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var s=t(24246),i=t(71670);const o={},a="Interface: InputBoxValidationMessage",r={id:"interfaces/InputBoxValidationMessage",title:"Interface: InputBoxValidationMessage",description:"Object to configure the behavior of the validation message.",source:"@site/api/interfaces/InputBoxValidationMessage.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"},next:{title:"InstallCheck",permalink:"/api/interfaces/InstallCheck"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Source",id:"source",level:4},{value:"severity",id:"severity",level:3},{value:"Source",id:"source-1",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,s.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L862",children:"packages/extension-api/src/extension-api.d.ts:862"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"severity",children:"severity"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"severity"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,s.jsx)(n.code,{children:"Info"})," and ",(0,s.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var s=t(27378);const i={},o=s.createContext(i);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{4069:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=t(24246),i=t(71670);const o={},a="Interface: InputBoxValidationMessage",r={id:"interfaces/InputBoxValidationMessage",title:"Interface: InputBoxValidationMessage",description:"Object to configure the behavior of the validation message.",source:"@site/api/interfaces/InputBoxValidationMessage.md",sourceDirName:"interfaces",slug:"/interfaces/InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxOptions",permalink:"/api/interfaces/InputBoxOptions"},next:{title:"InstallCheck",permalink:"/api/interfaces/InstallCheck"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Source",id:"source",level:4},{value:"severity",id:"severity",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-inputboxvalidationmessage",children:"Interface: InputBoxValidationMessage"}),"\n",(0,s.jsx)(n.p,{children:"Object to configure the behavior of the validation message."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"message"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The validation message to display."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L862",children:"packages/extension-api/src/extension-api.d.ts:862"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"severity",children:"severity"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"readonly"})," ",(0,s.jsx)(n.strong,{children:"severity"}),": ",(0,s.jsx)(n.a,{href:"/api/enumerations/InputBoxValidationSeverity",children:(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The severity of the validation message.\nNOTE: When using ",(0,s.jsx)(n.code,{children:"InputBoxValidationSeverity.Error"}),", the user will not be allowed to accept (hit ENTER) the input.\n",(0,s.jsx)(n.code,{children:"Info"})," and ",(0,s.jsx)(n.code,{children:"Warning"})," will still allow the InputBox to accept the input."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L869",children:"packages/extension-api/src/extension-api.d.ts:869"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>r,a:()=>a});var s=t(27378);const i={},o=s.createContext(i);function a(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c2865a15.ec2a87b6.js b/assets/js/c2865a15.b0cea802.js similarity index 97% rename from assets/js/c2865a15.ec2a87b6.js rename to assets/js/c2865a15.b0cea802.js index c5511e4b773..392361ae691 100644 --- a/assets/js/c2865a15.ec2a87b6.js +++ b/assets/js/c2865a15.b0cea802.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{39122:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var o=n(24246),s=n(71670);const i={},a="Type alias: MountType",c={id:"type-aliases/MountType",title:"Type alias: MountType",description:'MountType: "bind" \\| "volume" \\| "tmpfs"',source:"@site/api/type-aliases/MountType.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountType",permalink:"/api/type-aliases/MountType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountPropagation",permalink:"/api/type-aliases/MountPropagation"},next:{title:"NotificationType",permalink:"/api/type-aliases/NotificationType"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mounttype",children:"Type alias: MountType"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountType"}),": ",(0,o.jsx)(t.code,{children:'"bind"'})," | ",(0,o.jsx)(t.code,{children:'"volume"'})," | ",(0,o.jsx)(t.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2127",children:"packages/extension-api/src/extension-api.d.ts:2127"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var o=n(27378);const s={},i=o.createContext(s);function a(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{39122:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var o=n(24246),s=n(71670);const i={},a="Type alias: MountType",c={id:"type-aliases/MountType",title:"Type alias: MountType",description:'MountType: "bind" \\| "volume" \\| "tmpfs"',source:"@site/api/type-aliases/MountType.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountType",permalink:"/api/type-aliases/MountType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountPropagation",permalink:"/api/type-aliases/MountPropagation"},next:{title:"NotificationType",permalink:"/api/type-aliases/NotificationType"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mounttype",children:"Type alias: MountType"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountType"}),": ",(0,o.jsx)(t.code,{children:'"bind"'})," | ",(0,o.jsx)(t.code,{children:'"volume"'})," | ",(0,o.jsx)(t.code,{children:'"tmpfs"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2127",children:"packages/extension-api/src/extension-api.d.ts:2127"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var o=n(27378);const s={},i=o.createContext(s);function a(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c358ebbc.2d1ecb4d.js b/assets/js/c358ebbc.5aeedefe.js similarity index 96% rename from assets/js/c358ebbc.2d1ecb4d.js rename to assets/js/c358ebbc.5aeedefe.js index ccc1cd1cd40..0d177cc978e 100644 --- a/assets/js/c358ebbc.2d1ecb4d.js +++ b/assets/js/c358ebbc.5aeedefe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{1885:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=n(24246),r=n(71670);const t={},o="Interface: AuthenticationProvider",c={id:"interfaces/AuthenticationProvider",title:"Interface: AuthenticationProvider",description:"A provider for performing authentication to a service.",source:"@site/api/interfaces/AuthenticationProvider.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"},next:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"createSession()",id:"createsession",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"}),"\n",(0,i.jsx)(s.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"onDidChangeSessions"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(s.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["An ",(0,i.jsx)(s.a,{href:"#Event",children:"event"})," which fires when the array of sessions has changed, or data\nwithin a session has changed."]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3593",children:"packages/extension-api/src/extension-api.d.ts:3593"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"createSession"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"): ",(0,i.jsx)(s.code,{children:"Promise"})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(s.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(s.p,{children:"If the provider has specified that it does not support multiple accounts,\nthen this should never be called if there is already an existing session matching these\nscopes."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"A list of scopes, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),">"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3616",children:"packages/extension-api/src/extension-api.d.ts:3616"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getSessions"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"?): ",(0,i.jsx)(s.code,{children:"Promise"}),""]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes?"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3601",children:"packages/extension-api/src/extension-api.d.ts:3601"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"removeSession"}),"(",(0,i.jsx)(s.code,{children:"sessionId"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(s.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"sessionId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n",(0,i.jsx)(s.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3626",children:"packages/extension-api/src/extension-api.d.ts:3626"})})]})}function l(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(27378);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{1885:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=n(24246),r=n(71670);const t={},o="Interface: AuthenticationProvider",c={id:"interfaces/AuthenticationProvider",title:"Interface: AuthenticationProvider",description:"A provider for performing authentication to a service.",source:"@site/api/interfaces/AuthenticationProvider.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"},next:{title:"AuthenticationProviderAuthenticationSessionsChangeEvent",permalink:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"onDidChangeSessions",id:"ondidchangesessions",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"createSession()",id:"createsession",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"getSessions()",id:"getsessions",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4},{value:"removeSession()",id:"removesession",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-3",level:4}];function h(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"interface-authenticationprovider",children:"Interface: AuthenticationProvider"}),"\n",(0,i.jsx)(s.p,{children:"A provider for performing authentication to a service."}),"\n",(0,i.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(s.h3,{id:"ondidchangesessions",children:"onDidChangeSessions"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"readonly"})," ",(0,i.jsx)(s.strong,{children:"onDidChangeSessions"}),": ",(0,i.jsx)(s.a,{href:"/api/interfaces/Event",children:(0,i.jsx)(s.code,{children:"Event"})})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",children:(0,i.jsx)(s.code,{children:"AuthenticationProviderAuthenticationSessionsChangeEvent"})}),">"]}),"\n"]}),"\n",(0,i.jsxs)(s.p,{children:["An ",(0,i.jsx)(s.a,{href:"#Event",children:"event"})," which fires when the array of sessions has changed, or data\nwithin a session has changed."]}),"\n",(0,i.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3593",children:"packages/extension-api/src/extension-api.d.ts:3593"})}),"\n",(0,i.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(s.h3,{id:"createsession",children:"createSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"createSession"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"): ",(0,i.jsx)(s.code,{children:"Promise"})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Prompts a user to login."}),"\n",(0,i.jsx)(s.p,{children:"If login is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If login fails, a rejected promise should be returned."}),"\n",(0,i.jsx)(s.p,{children:"If the provider has specified that it does not support multiple accounts,\nthen this should never be called if there is already an existing session matching these\nscopes."}),"\n",(0,i.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"A list of scopes, permissions, that the new session should be created with."}),"\n",(0,i.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"})," <",(0,i.jsx)(s.a,{href:"/api/interfaces/AuthenticationSession",children:(0,i.jsx)(s.code,{children:"AuthenticationSession"})}),">"]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an authentication session."}),"\n",(0,i.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3616",children:"packages/extension-api/src/extension-api.d.ts:3616"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"getsessions",children:"getSessions()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"getSessions"}),"(",(0,i.jsx)(s.code,{children:"scopes"}),"?): ",(0,i.jsx)(s.code,{children:"Promise"}),""]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Get a list of sessions."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"scopes?"}),": ",(0,i.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,i.jsx)(s.p,{children:"An optional list of scopes. If provided, the sessions returned should match\nthese permissions, otherwise all sessions should be returned."}),"\n",(0,i.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),""]}),"\n",(0,i.jsx)(s.p,{children:"A promise that resolves to an array of authentication sessions."}),"\n",(0,i.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3601",children:"packages/extension-api/src/extension-api.d.ts:3601"})}),"\n",(0,i.jsx)(s.hr,{}),"\n",(0,i.jsx)(s.h3,{id:"removesession",children:"removeSession()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"removeSession"}),"(",(0,i.jsx)(s.code,{children:"sessionId"}),"): ",(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,i.jsx)(s.p,{children:"Removes the session corresponding to session id."}),"\n",(0,i.jsx)(s.p,{children:"If the removal is successful, the onDidChangeSessions event should be fired."}),"\n",(0,i.jsx)(s.p,{children:"If a session cannot be removed, the provider should reject with an error message."}),"\n",(0,i.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"sessionId"}),": ",(0,i.jsx)(s.code,{children:"string"})]}),"\n",(0,i.jsx)(s.p,{children:"The id of the session to remove."}),"\n",(0,i.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"Promise"}),"<",(0,i.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3626",children:"packages/extension-api/src/extension-api.d.ts:3626"})})]})}function l(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(27378);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c544b2d7.d1c1c256.js b/assets/js/c544b2d7.bfdb33ab.js similarity index 88% rename from assets/js/c544b2d7.d1c1c256.js rename to assets/js/c544b2d7.bfdb33ab.js index 624d658c625..30fad33b663 100644 --- a/assets/js/c544b2d7.d1c1c256.js +++ b/assets/js/c544b2d7.bfdb33ab.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{53683:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Link",permalink:"/api/interfaces/Link"},next:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3081",children:"packages/extension-api/src/extension-api.d.ts:3081"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{53683:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const r={},o="Interface: ListImagesOptions",a={id:"interfaces/ListImagesOptions",title:"Interface: ListImagesOptions",description:"Properties",source:"@site/api/interfaces/ListImagesOptions.md",sourceDirName:"interfaces",slug:"/interfaces/ListImagesOptions",permalink:"/api/interfaces/ListImagesOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Link",permalink:"/api/interfaces/Link"},next:{title:"ListInfosOptions",permalink:"/api/interfaces/ListInfosOptions"}},c={},l=[{value:"Properties",id:"properties",level:2},{value:"provider?",id:"provider",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-listimagesoptions",children:"Interface: ListImagesOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"provider"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,i.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The provider we want to list the images. If not provided, will return all container images across all container engines."}),"\n",(0,i.jsx)(n.h4,{id:"default-value",children:"Default Value"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3081",children:"packages/extension-api/src/extension-api.d.ts:3081"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>o});var i=t(27378);const s={},r=i.createContext(s);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7cac05f.b5970dda.js b/assets/js/c7cac05f.900be9d5.js similarity index 93% rename from assets/js/c7cac05f.b5970dda.js rename to assets/js/c7cac05f.900be9d5.js index dcc4678321a..792d2c2647c 100644 --- a/assets/js/c7cac05f.b5970dda.js +++ b/assets/js/c7cac05f.900be9d5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{88517:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(24246),o=i(71670);const t={},r="Interface: OpenDialogOptions",c={id:"interfaces/OpenDialogOptions",title:"Interface: OpenDialogOptions",description:"Options to configure the behaviour of a file open dialog.",source:"@site/api/interfaces/OpenDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"},next:{title:"PidsStats",permalink:"/api/interfaces/PidsStats"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Source",id:"source-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"defaultUri"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1556",children:"packages/extension-api/src/extension-api.d.ts:1556"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"filters"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1572",children:"packages/extension-api/src/extension-api.d.ts:1572"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"openlabel",children:"openLabel?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"openLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string for the open button."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1561",children:"packages/extension-api/src/extension-api.d.ts:1561"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"selectors",children:"selectors?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"selectors"}),": (",(0,s.jsx)(n.code,{children:'"openFile"'})," | ",(0,s.jsx)(n.code,{children:'"openDirectory"'})," | ",(0,s.jsx)(n.code,{children:'"multiSelections"'})," | ",(0,s.jsx)(n.code,{children:'"showHiddenFiles"'}),")[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Contains which features the dialog should use. The following values are\nsupported:"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1567",children:"packages/extension-api/src/extension-api.d.ts:1567"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dialog title."}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1580",children:"packages/extension-api/src/extension-api.d.ts:1580"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{88517:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var s=i(24246),o=i(71670);const t={},r="Interface: OpenDialogOptions",c={id:"interfaces/OpenDialogOptions",title:"Interface: OpenDialogOptions",description:"Options to configure the behaviour of a file open dialog.",source:"@site/api/interfaces/OpenDialogOptions.md",sourceDirName:"interfaces",slug:"/interfaces/OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NotificationOptions",permalink:"/api/interfaces/NotificationOptions"},next:{title:"PidsStats",permalink:"/api/interfaces/PidsStats"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"defaultUri?",id:"defaulturi",level:3},{value:"Source",id:"source",level:4},{value:"filters?",id:"filters",level:3},{value:"Source",id:"source-1",level:4},{value:"openLabel?",id:"openlabel",level:3},{value:"Source",id:"source-2",level:4},{value:"selectors?",id:"selectors",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-opendialogoptions",children:"Interface: OpenDialogOptions"}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behaviour of a file open dialog."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"defaulturi",children:"defaultUri?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"defaultUri"}),": ",(0,s.jsx)(n.a,{href:"/api/classes/Uri",children:(0,s.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The resource the dialog shows when opened."}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1556",children:"packages/extension-api/src/extension-api.d.ts:1556"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"filters",children:"filters?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"filters"}),": ",(0,s.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A set of file filters that are used by the dialog."}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1572",children:"packages/extension-api/src/extension-api.d.ts:1572"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"openlabel",children:"openLabel?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"openLabel"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"A human-readable string for the open button."}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1561",children:"packages/extension-api/src/extension-api.d.ts:1561"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"selectors",children:"selectors?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"selectors"}),": (",(0,s.jsx)(n.code,{children:'"openFile"'})," | ",(0,s.jsx)(n.code,{children:'"openDirectory"'})," | ",(0,s.jsx)(n.code,{children:'"multiSelections"'})," | ",(0,s.jsx)(n.code,{children:'"showHiddenFiles"'}),")[]"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Contains which features the dialog should use. The following values are\nsupported:"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1567",children:"packages/extension-api/src/extension-api.d.ts:1567"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"title"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Dialog title."}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1580",children:"packages/extension-api/src/extension-api.d.ts:1580"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var s=i(27378);const o={},t=s.createContext(o);function r(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c813bd67.7eeca794.js b/assets/js/c813bd67.3e01ddab.js similarity index 91% rename from assets/js/c813bd67.7eeca794.js rename to assets/js/c813bd67.3e01ddab.js index 4bddda74562..1f7c2772ada 100644 --- a/assets/js/c813bd67.7eeca794.js +++ b/assets/js/c813bd67.3e01ddab.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{57150:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: IPAM",o={id:"interfaces/IPAM",title:"Interface: IPAM",description:"Properties",source:"@site/api/interfaces/IPAM.md",sourceDirName:"interfaces",slug:"/interfaces/IPAM",permalink:"/api/interfaces/IPAM",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"},next:{title:"ImageCheck",permalink:"/api/interfaces/ImageCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1998",children:"packages/extension-api/src/extension-api.d.ts:1998"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1997",children:"packages/extension-api/src/extension-api.d.ts:1997"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1999",children:"packages/extension-api/src/extension-api.d.ts:1999"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{57150:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var i=s(24246),r=s(71670);const t={},c="Interface: IPAM",o={id:"interfaces/IPAM",title:"Interface: IPAM",description:"Properties",source:"@site/api/interfaces/IPAM.md",sourceDirName:"interfaces",slug:"/interfaces/IPAM",permalink:"/api/interfaces/IPAM",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"},next:{title:"ImageCheck",permalink:"/api/interfaces/ImageCheck"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"Config?",id:"config",level:3},{value:"Source",id:"source",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-1",level:4},{value:"Options?",id:"options",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-ipam",children:"Interface: IPAM"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1998",children:"packages/extension-api/src/extension-api.d.ts:1998"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1997",children:"packages/extension-api/src/extension-api.d.ts:1997"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"options",children:"Options?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Options"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1999",children:"packages/extension-api/src/extension-api.d.ts:1999"})})]})}function p(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const r={},t=i.createContext(r);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca1234c1.df894251.js b/assets/js/ca1234c1.a3a32778.js similarity index 89% rename from assets/js/ca1234c1.df894251.js rename to assets/js/ca1234c1.a3a32778.js index 75a6a95cb59..5d712e070a7 100644 --- a/assets/js/ca1234c1.df894251.js +++ b/assets/js/ca1234c1.a3a32778.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{33160:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=o(24246),t=o(71670);const i={},s="Interface: TelemetryLoggerOptions",c={id:"interfaces/TelemetryLoggerOptions",title:"Interface: TelemetryLoggerOptions",description:"Options for creating a TelemetryLogger",source:"@site/api/interfaces/TelemetryLoggerOptions.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"},next:{title:"TelemetrySender",permalink:"/api/interfaces/TelemetrySender"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Source",id:"source",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Source",id:"source-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-telemetryloggeroptions",children:"Interface: TelemetryLoggerOptions"}),"\n",(0,r.jsxs)(n.p,{children:["Options for creating a ",(0,r.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"additionalcommonproperties",children:"additionalCommonProperties?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"additionalCommonProperties"}),": ",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Any additional common properties which should be injected into the data object."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3997",children:"packages/extension-api/src/extension-api.d.ts:3997"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignorebuiltincommonproperties",children:"ignoreBuiltInCommonProperties?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"ignoreBuiltInCommonProperties"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Whether or not you want to avoid having the built-in common properties such as os, extension name, etc injected into the data object.\nDefaults to ",(0,r.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3985",children:"packages/extension-api/src/extension-api.d.ts:3985"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignoreunhandlederrors",children:"ignoreUnhandledErrors?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"ignoreUnhandledErrors"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Whether or not unhandled errors on the extension host caused by your extension should be logged to your sender.\nDefaults to ",(0,r.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3991",children:"packages/extension-api/src/extension-api.d.ts:3991"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>s});var r=o(27378);const t={},i=r.createContext(t);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{33160:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=o(24246),t=o(71670);const i={},s="Interface: TelemetryLoggerOptions",c={id:"interfaces/TelemetryLoggerOptions",title:"Interface: TelemetryLoggerOptions",description:"Options for creating a TelemetryLogger",source:"@site/api/interfaces/TelemetryLoggerOptions.md",sourceDirName:"interfaces",slug:"/interfaces/TelemetryLoggerOptions",permalink:"/api/interfaces/TelemetryLoggerOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetryLogger",permalink:"/api/interfaces/TelemetryLogger"},next:{title:"TelemetrySender",permalink:"/api/interfaces/TelemetrySender"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"additionalCommonProperties?",id:"additionalcommonproperties",level:3},{value:"Source",id:"source",level:4},{value:"ignoreBuiltInCommonProperties?",id:"ignorebuiltincommonproperties",level:3},{value:"Source",id:"source-1",level:4},{value:"ignoreUnhandledErrors?",id:"ignoreunhandlederrors",level:3},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-telemetryloggeroptions",children:"Interface: TelemetryLoggerOptions"}),"\n",(0,r.jsxs)(n.p,{children:["Options for creating a ",(0,r.jsx)(n.a,{href:"/api/interfaces/TelemetryLogger",children:"TelemetryLogger"})]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"additionalcommonproperties",children:"additionalCommonProperties?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"additionalCommonProperties"}),": ",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Any additional common properties which should be injected into the data object."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3997",children:"packages/extension-api/src/extension-api.d.ts:3997"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignorebuiltincommonproperties",children:"ignoreBuiltInCommonProperties?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"ignoreBuiltInCommonProperties"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Whether or not you want to avoid having the built-in common properties such as os, extension name, etc injected into the data object.\nDefaults to ",(0,r.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3985",children:"packages/extension-api/src/extension-api.d.ts:3985"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ignoreunhandlederrors",children:"ignoreUnhandledErrors?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.code,{children:"readonly"})," ",(0,r.jsx)(n.strong,{children:"ignoreUnhandledErrors"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Whether or not unhandled errors on the extension host caused by your extension should be logged to your sender.\nDefaults to ",(0,r.jsx)(n.code,{children:"false"})," if not defined."]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3991",children:"packages/extension-api/src/extension-api.d.ts:3991"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>s});var r=o(27378);const t={},i=r.createContext(t);function s(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ca165b51.8ff4783c.js b/assets/js/ca165b51.ddd888c4.js similarity index 93% rename from assets/js/ca165b51.8ff4783c.js rename to assets/js/ca165b51.ddd888c4.js index ed444768f6d..22615939397 100644 --- a/assets/js/ca165b51.8ff4783c.js +++ b/assets/js/ca165b51.ddd888c4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{88751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(24246),s=t(71670);const o={},i="Interface: ProxySettings",c={id:"interfaces/ProxySettings",title:"Interface: ProxySettings",description:"Properties",source:"@site/api/interfaces/ProxySettings.md",sourceDirName:"interfaces",slug:"/interfaces/ProxySettings",permalink:"/api/interfaces/ProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"},next:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Source",id:"source",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Source",id:"source-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"noProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{88751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=t(24246),s=t(71670);const o={},i="Interface: ProxySettings",c={id:"interfaces/ProxySettings",title:"Interface: ProxySettings",description:"Properties",source:"@site/api/interfaces/ProxySettings.md",sourceDirName:"interfaces",slug:"/interfaces/ProxySettings",permalink:"/api/interfaces/ProxySettings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate"},next:{title:"PullEvent",permalink:"/api/interfaces/PullEvent"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"httpProxy",id:"httpproxy",level:3},{value:"Source",id:"source",level:4},{value:"httpsProxy",id:"httpsproxy",level:3},{value:"Source",id:"source-1",level:4},{value:"noProxy",id:"noproxy",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-proxysettings",children:"Interface: ProxySettings"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"httpproxy",children:"httpProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L605",children:"packages/extension-api/src/extension-api.d.ts:605"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"httpsproxy",children:"httpsProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"httpsProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"noproxy",children:"noProxy"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"noProxy"}),": ",(0,r.jsx)(n.code,{children:"undefined"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L607",children:"packages/extension-api/src/extension-api.d.ts:607"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var r=t(27378);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/caddb1c0.44436372.js b/assets/js/caddb1c0.66d67b2b.js similarity index 94% rename from assets/js/caddb1c0.44436372.js rename to assets/js/caddb1c0.66d67b2b.js index 5560dfaec39..98b72fd7d78 100644 --- a/assets/js/caddb1c0.44436372.js +++ b/assets/js/caddb1c0.66d67b2b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{85879:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var s=r(24246),i=r(71670);const c={},o="Interface: ProviderConnectionLifecycle",t={id:"interfaces/ProviderConnectionLifecycle",title:"Interface: ProviderConnectionLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderConnectionLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"},next:{title:"ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"}},d={},l=[{value:"Methods",id:"methods",level:2},{value:"delete()?",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L269",children:"packages/extension-api/src/extension-api.d.ts:269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"edit"}),"(",(0,s.jsx)(n.code,{children:"editContext"}),", ",(0,s.jsx)(n.code,{children:"params"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"editContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"params"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"token?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L270",children:"packages/extension-api/src/extension-api.d.ts:270"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"start()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"start"}),"(",(0,s.jsx)(n.code,{children:"startContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L267",children:"packages/extension-api/src/extension-api.d.ts:267"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L268",children:"packages/extension-api/src/extension-api.d.ts:268"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>t,a:()=>o});var s=r(27378);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{85879:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var s=r(24246),i=r(71670);const c={},o="Interface: ProviderConnectionLifecycle",t={id:"interfaces/ProviderConnectionLifecycle",title:"Interface: ProviderConnectionLifecycle",description:"Methods",source:"@site/api/interfaces/ProviderConnectionLifecycle.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderConnectionLifecycle",permalink:"/api/interfaces/ProviderConnectionLifecycle",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderConnectionFactory",permalink:"/api/interfaces/ProviderConnectionFactory"},next:{title:"ProviderContainerConnection",permalink:"/api/interfaces/ProviderContainerConnection"}},d={},l=[{value:"Methods",id:"methods",level:2},{value:"delete()?",id:"delete",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"edit()?",id:"edit",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4},{value:"start()?",id:"start",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Source",id:"source-2",level:4},{value:"stop()?",id:"stop",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Source",id:"source-3",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerconnectionlifecycle",children:"Interface: ProviderConnectionLifecycle"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"delete",children:"delete()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"delete"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L269",children:"packages/extension-api/src/extension-api.d.ts:269"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"edit",children:"edit()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"edit"}),"(",(0,s.jsx)(n.code,{children:"editContext"}),", ",(0,s.jsx)(n.code,{children:"params"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?, ",(0,s.jsx)(n.code,{children:"token"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"editContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"params"})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"token?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,s.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L270",children:"packages/extension-api/src/extension-api.d.ts:270"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"start",children:"start()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"start"}),"(",(0,s.jsx)(n.code,{children:"startContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"startContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L267",children:"packages/extension-api/src/extension-api.d.ts:267"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"stop",children:"stop()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"stop"}),"(",(0,s.jsx)(n.code,{children:"stopContext"}),", ",(0,s.jsx)(n.code,{children:"logger"}),"?): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"stopContext"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/LifecycleContext",children:(0,s.jsx)(n.code,{children:"LifecycleContext"})})]}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger?"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L268",children:"packages/extension-api/src/extension-api.d.ts:268"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>t,a:()=>o});var s=r(27378);const i={},c=s.createContext(i);function o(e){const n=s.useContext(c);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb0f21df.d52947d5.js b/assets/js/cb0f21df.2794e421.js similarity index 90% rename from assets/js/cb0f21df.d52947d5.js rename to assets/js/cb0f21df.2794e421.js index e6a319491b5..21438b95328 100644 --- a/assets/js/cb0f21df.d52947d5.js +++ b/assets/js/cb0f21df.2794e421.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{16989:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Interface: UpdateKubernetesConnectionEvent",c={id:"interfaces/UpdateKubernetesConnectionEvent",title:"Interface: UpdateKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"},next:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L559",children:"packages/extension-api/src/extension-api.d.ts:559"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"providerId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L558",children:"packages/extension-api/src/extension-api.d.ts:558"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,s.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L560",children:"packages/extension-api/src/extension-api.d.ts:560"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{16989:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(24246),r=t(71670);const o={},i="Interface: UpdateKubernetesConnectionEvent",c={id:"interfaces/UpdateKubernetesConnectionEvent",title:"Interface: UpdateKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/UpdateKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/UpdateKubernetesConnectionEvent",permalink:"/api/interfaces/UpdateKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"UpdateContainerConnectionEvent",permalink:"/api/interfaces/UpdateContainerConnectionEvent"},next:{title:"VolumeCreateOptions",permalink:"/api/interfaces/VolumeCreateOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"connection",id:"connection",level:3},{value:"Source",id:"source",level:4},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source-1",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-2",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-updatekubernetesconnectionevent",children:"Interface: UpdateKubernetesConnectionEvent"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"connection",children:"connection"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"connection"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnection",children:(0,s.jsx)(n.code,{children:"KubernetesProviderConnection"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L559",children:"packages/extension-api/src/extension-api.d.ts:559"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"providerId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L558",children:"packages/extension-api/src/extension-api.d.ts:558"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"status"}),": ",(0,s.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,s.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L560",children:"packages/extension-api/src/extension-api.d.ts:560"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var s=t(27378);const r={},o=s.createContext(r);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc6d9416.c56a785a.js b/assets/js/cc6d9416.aeb8f324.js similarity index 81% rename from assets/js/cc6d9416.c56a785a.js rename to assets/js/cc6d9416.aeb8f324.js index 31cf77b6bee..99cec94d41b 100644 --- a/assets/js/cc6d9416.c56a785a.js +++ b/assets/js/cc6d9416.aeb8f324.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{66687:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=s(24246),i=s(71670);const t={},o="Interface: AuthConfig",c={id:"interfaces/AuthConfig",title:"Interface: AuthConfig",description:"Properties",source:"@site/api/interfaces/AuthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/AuthConfig",permalink:"/api/interfaces/AuthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Auditor",permalink:"/api/interfaces/Auditor"},next:{title:"AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2102",children:"packages/extension-api/src/extension-api.d.ts:2102"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{66687:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const t={},c="Interface: AuthConfig",o={id:"interfaces/AuthConfig",title:"Interface: AuthConfig",description:"Properties",source:"@site/api/interfaces/AuthConfig.md",sourceDirName:"interfaces",slug:"/interfaces/AuthConfig",permalink:"/api/interfaces/AuthConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Auditor",permalink:"/api/interfaces/Auditor"},next:{title:"AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"email?",id:"email",level:3},{value:"Source",id:"source",level:4},{value:"password",id:"password",level:3},{value:"Source",id:"source-1",level:4},{value:"serveraddress",id:"serveraddress",level:3},{value:"Source",id:"source-2",level:4},{value:"username",id:"username",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-authconfig",children:"Interface: AuthConfig"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"email",children:"email?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"email"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"password",children:"password"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"password"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"serveraddress",children:"serveraddress"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"serveraddress"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2102",children:"packages/extension-api/src/extension-api.d.ts:2102"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"username",children:"username"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"username"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var r=s(27378);const i={},t=r.createContext(i);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cc922df3.a10fbb17.js b/assets/js/cc922df3.71c3f7f0.js similarity index 94% rename from assets/js/cc922df3.a10fbb17.js rename to assets/js/cc922df3.71c3f7f0.js index 50f460ad2cd..f503b53aea9 100644 --- a/assets/js/cc922df3.a10fbb17.js +++ b/assets/js/cc922df3.71c3f7f0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{47449:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=i(24246),s=i(71670);const o={},r="Interface: AuthenticationGetSessionOptions",c={id:"interfaces/AuthenticationGetSessionOptions",title:"Interface: AuthenticationGetSessionOptions",description:"Options to be used when getting an AuthenticationSession from an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationGetSessionOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthConfig",permalink:"/api/interfaces/AuthConfig"},next:{title:"AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Source",id:"source",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Source",id:"source-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationgetsessionoptions",children:"Interface: AuthenticationGetSessionOptions"}),"\n",(0,t.jsxs)(n.p,{children:["Options to be used when getting an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," from an ",(0,t.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"clearsessionpreference",children:"clearSessionPreference?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3497",children:"packages/extension-api/src/extension-api.d.ts:3497"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"createifnone",children:"createIfNone?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"createIfNone"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether login should be performed if there is no matching session."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown\non the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This\nallows quietly prompting the user to sign in."}),"\n",(0,t.jsx)(n.p,{children:"If there is a matching session but the extension has not been granted access to it, setting this to true\nwill also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3486",children:"packages/extension-api/src/extension-api.d.ts:3486"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"forcenewsession",children:"forceNewSession?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"forceNewSession"}),": ",(0,t.jsx)(n.code,{children:"boolean"})," | ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should attempt to reauthenticate even if there is already a session available."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios\nwhere the token needs to be re minted because it has lost some authorization."}),"\n",(0,t.jsxs)(n.p,{children:["If there are no existing sessions and forceNewSession is true, it will behave identically to\n",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3510",children:"packages/extension-api/src/extension-api.d.ts:3510"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should show the indication to sign in in the Accounts menu."}),"\n",(0,t.jsx)(n.p,{children:"If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.\nIf true, no indication will be shown."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsxs)(n.p,{children:["Note: you cannot use this option with any other options that prompt the user like ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3522",children:"packages/extension-api/src/extension-api.d.ts:3522"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{47449:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=i(24246),s=i(71670);const o={},r="Interface: AuthenticationGetSessionOptions",c={id:"interfaces/AuthenticationGetSessionOptions",title:"Interface: AuthenticationGetSessionOptions",description:"Options to be used when getting an AuthenticationSession from an AuthenticationProvider.",source:"@site/api/interfaces/AuthenticationGetSessionOptions.md",sourceDirName:"interfaces",slug:"/interfaces/AuthenticationGetSessionOptions",permalink:"/api/interfaces/AuthenticationGetSessionOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuthConfig",permalink:"/api/interfaces/AuthConfig"},next:{title:"AuthenticationProvider",permalink:"/api/interfaces/AuthenticationProvider"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"clearSessionPreference?",id:"clearsessionpreference",level:3},{value:"Source",id:"source",level:4},{value:"createIfNone?",id:"createifnone",level:3},{value:"Source",id:"source-1",level:4},{value:"forceNewSession?",id:"forcenewsession",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-authenticationgetsessionoptions",children:"Interface: AuthenticationGetSessionOptions"}),"\n",(0,t.jsxs)(n.p,{children:["Options to be used when getting an ",(0,t.jsx)(n.a,{href:"#AuthenticationSession",children:"AuthenticationSession"})," from an ",(0,t.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"clearsessionpreference",children:"clearSessionPreference?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"clearSessionPreference"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether the existing user session preference should be cleared."}),"\n",(0,t.jsxs)(n.p,{children:["For authentication providers that support being signed into multiple accounts at once, the user will be\nprompted to select an account to use when ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called. This preference\nis remembered until ",(0,t.jsx)(n.a,{href:"#authentication.getSession",children:"getSession"})," is called with this flag."]}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3497",children:"packages/extension-api/src/extension-api.d.ts:3497"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"createifnone",children:"createIfNone?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"createIfNone"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether login should be performed if there is no matching session."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown\non the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This\nallows quietly prompting the user to sign in."}),"\n",(0,t.jsx)(n.p,{children:"If there is a matching session but the extension has not been granted access to it, setting this to true\nwill also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3486",children:"packages/extension-api/src/extension-api.d.ts:3486"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"forcenewsession",children:"forceNewSession?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"forceNewSession"}),": ",(0,t.jsx)(n.code,{children:"boolean"})," | ",(0,t.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should attempt to reauthenticate even if there is already a session available."}),"\n",(0,t.jsx)(n.p,{children:"If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios\nwhere the token needs to be re minted because it has lost some authorization."}),"\n",(0,t.jsxs)(n.p,{children:["If there are no existing sessions and forceNewSession is true, it will behave identically to\n",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"This defaults to false."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3510",children:"packages/extension-api/src/extension-api.d.ts:3510"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether we should show the indication to sign in in the Accounts menu."}),"\n",(0,t.jsx)(n.p,{children:"If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.\nIf true, no indication will be shown."}),"\n",(0,t.jsx)(n.p,{children:"Defaults to false."}),"\n",(0,t.jsxs)(n.p,{children:["Note: you cannot use this option with any other options that prompt the user like ",(0,t.jsx)(n.a,{href:"/api/interfaces/AuthenticationGetSessionOptions#createifnone",children:"createIfNone"}),"."]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3522",children:"packages/extension-api/src/extension-api.d.ts:3522"})})]})}function d(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>r});var t=i(27378);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cdf64ea9.af019513.js b/assets/js/cdf64ea9.f1566cd3.js similarity index 92% rename from assets/js/cdf64ea9.af019513.js rename to assets/js/cdf64ea9.f1566cd3.js index 89384f37b10..c170ed58b8d 100644 --- a/assets/js/cdf64ea9.af019513.js +++ b/assets/js/cdf64ea9.f1566cd3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{36533:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const c={},d="Interface: RunError",o={id:"interfaces/RunError",title:"Interface: RunError",description:"Represents an error that occurred during the execution of a command.",source:"@site/api/interfaces/RunError.md",sourceDirName:"interfaces",slug:"/interfaces/RunError",permalink:"/api/interfaces/RunError",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"},next:{title:"RunOptions",permalink:"/api/interfaces/RunOptions"}},t={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Source",id:"source",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Source",id:"source-3",level:4},{value:"killed",id:"killed",level:3},{value:"Source",id:"source-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Source",id:"source-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"}),"\n",(0,r.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"cancelled"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cause"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3832",children:"packages/extension-api/src/extension-api.d.ts:3832"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exitCode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3827",children:"packages/extension-api/src/extension-api.d.ts:3827"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"killed"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3852",children:"packages/extension-api/src/extension-api.d.ts:3852"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The error message."}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.message"})}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3822",children:"packages/extension-api/src/extension-api.d.ts:3822"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.name"})}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stderr"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3842",children:"packages/extension-api/src/extension-api.d.ts:3842"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stdout"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{36533:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const c={},d="Interface: RunError",o={id:"interfaces/RunError",title:"Interface: RunError",description:"Represents an error that occurred during the execution of a command.",source:"@site/api/interfaces/RunError.md",sourceDirName:"interfaces",slug:"/interfaces/RunError",permalink:"/api/interfaces/RunError",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"},next:{title:"RunOptions",permalink:"/api/interfaces/RunOptions"}},t={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"cancelled",id:"cancelled",level:3},{value:"Source",id:"source",level:4},{value:"cause?",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source-1",level:4},{value:"command",id:"command",level:3},{value:"Source",id:"source-2",level:4},{value:"exitCode",id:"exitcode",level:3},{value:"Source",id:"source-3",level:4},{value:"killed",id:"killed",level:3},{value:"Source",id:"source-4",level:4},{value:"message",id:"message",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Source",id:"source-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-6",level:4},{value:"stack?",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-7",level:4},{value:"stderr",id:"stderr",level:3},{value:"Source",id:"source-8",level:4},{value:"stdout",id:"stdout",level:3},{value:"Source",id:"source-9",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-runerror",children:"Interface: RunError"}),"\n",(0,r.jsx)(n.p,{children:"Represents an error that occurred during the execution of a command."}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"cancelled",children:"cancelled"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"cancelled"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the execution was cancelled."}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"cause",children:"cause?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"cause"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.cause"})}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es2022.error.d.ts:24"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"command",children:"command"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"command"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The command that was executed."}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3832",children:"packages/extension-api/src/extension-api.d.ts:3832"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"exitcode",children:"exitCode"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"exitCode"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The exit code of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3827",children:"packages/extension-api/src/extension-api.d.ts:3827"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"killed",children:"killed"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"killed"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Indicates whether the process was forcefully killed."}),"\n",(0,r.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3852",children:"packages/extension-api/src/extension-api.d.ts:3852"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"message",children:"message"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"message"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The error message."}),"\n",(0,r.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.message"})}),"\n",(0,r.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3822",children:"packages/extension-api/src/extension-api.d.ts:3822"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.name"})}),"\n",(0,r.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1076"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stack",children:"stack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"stack"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Error.stack"})}),"\n",(0,r.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1078"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stderr",children:"stderr"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stderr"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard error (stderr) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3842",children:"packages/extension-api/src/extension-api.d.ts:3842"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"stdout",children:"stdout"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"stdout"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The standard output (stdout) content of the command."}),"\n",(0,r.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>d});var r=s(27378);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfdfe126.d29dd4fe.js b/assets/js/cfdfe126.b62b6dba.js similarity index 96% rename from assets/js/cfdfe126.d29dd4fe.js rename to assets/js/cfdfe126.b62b6dba.js index c2a021bafe1..eca572b8a7f 100644 --- a/assets/js/cfdfe126.d29dd4fe.js +++ b/assets/js/cfdfe126.b62b6dba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{5900:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=s(24246),t=s(71670);const i={},r="Function: showInformationMessage()",c={id:"namespaces/window/functions/showInformationMessage",title:"Function: showInformationMessage()",description:"showInformationMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showInformationMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"},next:{title:"showInputBox",permalink:"/api/namespaces/window/functions/showInputBox"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showinformationmessage",children:"Function: showInformationMessage()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showInformationMessage"}),"(",(0,o.jsx)(n.code,{children:"message"}),", ...",(0,o.jsx)(n.code,{children:"items"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Show an information message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"message"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"The message to show."}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ...",(0,o.jsx)(n.strong,{children:"items"}),": ",(0,o.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,o.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1630",children:"packages/extension-api/src/extension-api.d.ts:1630"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var o=s(27378);const t={},i=o.createContext(t);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{5900:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=s(24246),t=s(71670);const i={},r="Function: showInformationMessage()",c={id:"namespaces/window/functions/showInformationMessage",title:"Function: showInformationMessage()",description:"showInformationMessage(message, ...items): Promise\\",source:"@site/api/namespaces/window/functions/showInformationMessage.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showInformationMessage",permalink:"/api/namespaces/window/functions/showInformationMessage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showErrorMessage",permalink:"/api/namespaces/window/functions/showErrorMessage"},next:{title:"showInputBox",permalink:"/api/namespaces/window/functions/showInputBox"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"function-showinformationmessage",children:"Function: showInformationMessage()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"showInformationMessage"}),"(",(0,o.jsx)(n.code,{children:"message"}),", ...",(0,o.jsx)(n.code,{children:"items"}),"): ",(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Show an information message. Optionally provide an array of items which will be presented as\nclickable buttons."}),"\n",(0,o.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ",(0,o.jsx)(n.strong,{children:"message"}),": ",(0,o.jsx)(n.code,{children:"string"})]}),"\n",(0,o.jsx)(n.p,{children:"The message to show."}),"\n",(0,o.jsxs)(n.p,{children:["\u2022 ...",(0,o.jsx)(n.strong,{children:"items"}),": ",(0,o.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,o.jsx)(n.p,{children:"A set of items that will be rendered as actions in the message."}),"\n",(0,o.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Promise"}),"<",(0,o.jsx)(n.code,{children:"string"})," | ",(0,o.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,o.jsxs)(n.p,{children:["A promise that resolves to the selected item or ",(0,o.jsx)(n.code,{children:"undefined"})," when being dismissed."]}),"\n",(0,o.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1630",children:"packages/extension-api/src/extension-api.d.ts:1630"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>r});var o=s(27378);const t={},i=o.createContext(t);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d103759a.fe3c8be8.js b/assets/js/d103759a.07939a6c.js similarity index 98% rename from assets/js/d103759a.fe3c8be8.js rename to assets/js/d103759a.07939a6c.js index e375d1729c1..de131c0b6ee 100644 --- a/assets/js/d103759a.fe3c8be8.js +++ b/assets/js/d103759a.07939a6c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{2650:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var r=n(24246),s=n(71670);const a={},i="Function: createStatusBarItem()",c={id:"namespaces/window/functions/createStatusBarItem",title:"Function: createStatusBarItem()",description:"createStatusBarItem(alignment?, priority?): StatusBarItem",source:"@site/api/namespaces/window/functions/createStatusBarItem.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick"},next:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,r.jsx)(t.code,{children:"alignment"}),"?, ",(0,r.jsx)(t.code,{children:"priority"}),"?): ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["Creates a status bar ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"alignment?"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,r.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,r.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"priority?"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,r.jsx)(t.p,{children:"A new status bar item."}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1729",children:"packages/extension-api/src/extension-api.d.ts:1729"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);const s={},a=r.createContext(s);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{2650:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var r=n(24246),s=n(71670);const a={},i="Function: createStatusBarItem()",c={id:"namespaces/window/functions/createStatusBarItem",title:"Function: createStatusBarItem()",description:"createStatusBarItem(alignment?, priority?): StatusBarItem",source:"@site/api/namespaces/window/functions/createStatusBarItem.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/createStatusBarItem",permalink:"/api/namespaces/window/functions/createStatusBarItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createCustomPick",permalink:"/api/namespaces/window/functions/createCustomPick"},next:{title:"createWebviewPanel",permalink:"/api/namespaces/window/functions/createWebviewPanel"}},o={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"function-createstatusbaritem",children:"Function: createStatusBarItem()"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"createStatusBarItem"}),"(",(0,r.jsx)(t.code,{children:"alignment"}),"?, ",(0,r.jsx)(t.code,{children:"priority"}),"?): ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})]}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["Creates a status bar ",(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:"StatusBarItem"})," item."]}),"\n",(0,r.jsx)(t.h2,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"alignment?"}),": ",(0,r.jsx)(t.a,{href:"/api/type-aliases/StatusBarAlignment",children:(0,r.jsx)(t.code,{children:"StatusBarAlignment"})})]}),"\n",(0,r.jsx)(t.p,{children:"The alignment of the item."}),"\n",(0,r.jsxs)(t.p,{children:["\u2022 ",(0,r.jsx)(t.strong,{children:"priority?"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n",(0,r.jsx)(t.p,{children:"The priority of the item. Higher values mean more to the left or more to the right."}),"\n",(0,r.jsx)(t.h2,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"/api/interfaces/StatusBarItem",children:(0,r.jsx)(t.code,{children:"StatusBarItem"})})}),"\n",(0,r.jsx)(t.p,{children:"A new status bar item."}),"\n",(0,r.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1729",children:"packages/extension-api/src/extension-api.d.ts:1729"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>i});var r=n(27378);const s={},a=r.createContext(s);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d1163e47.c600fc62.js b/assets/js/d1163e47.581f856e.js similarity index 52% rename from assets/js/d1163e47.c600fc62.js rename to assets/js/d1163e47.581f856e.js index 6a893f4d3c5..e5c7adbf03e 100644 --- a/assets/js/d1163e47.c600fc62.js +++ b/assets/js/d1163e47.581f856e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{95237:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var a=t(24246),n=t(71670);const c={},i="Interface: ImageCheckerProviderMetadata",o={id:"interfaces/ImageCheckerProviderMetadata",title:"Interface: ImageCheckerProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageCheckerProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"},next:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Source",id:"source",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,a.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,a.jsx)(r.h3,{id:"label",children:"label"}),"\n",(0,a.jsxs)(r.blockquote,{children:["\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.code,{children:"readonly"})," ",(0,a.jsx)(r.strong,{children:"label"}),": ",(0,a.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,a.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4153",children:"packages/extension-api/src/extension-api.d.ts:4153"})})]})}function h(e={}){const{wrapper:r}={...(0,n.a)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>i});var a=t(27378);const n={},c=a.createContext(n);function i(e){const r=a.useContext(c);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),a.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{95237:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var n=t(24246),a=t(71670);const c={},i="Interface: ImageCheckerProviderMetadata",o={id:"interfaces/ImageCheckerProviderMetadata",title:"Interface: ImageCheckerProviderMetadata",description:"Properties",source:"@site/api/interfaces/ImageCheckerProviderMetadata.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheckerProviderMetadata",permalink:"/api/interfaces/ImageCheckerProviderMetadata",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"},next:{title:"ImageChecks",permalink:"/api/interfaces/ImageChecks"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"label",id:"label",level:3},{value:"Source",id:"source",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-imagecheckerprovidermetadata",children:"Interface: ImageCheckerProviderMetadata"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"label"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"label"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4153",children:"packages/extension-api/src/extension-api.d.ts:4153"})})]})}function h(e={}){const{wrapper:r}={...(0,a.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>i});var n=t(27378);const a={},c=n.createContext(a);function i(e){const r=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),n.createElement(c.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d46ef83d.264e9921.js b/assets/js/d46ef83d.137b9d8f.js similarity index 84% rename from assets/js/d46ef83d.264e9921.js rename to assets/js/d46ef83d.137b9d8f.js index 25aa9c6ba25..eb632646a7e 100644 --- a/assets/js/d46ef83d.264e9921.js +++ b/assets/js/d46ef83d.137b9d8f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{96129:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>p});var o=n(24246),a=n(71670);const s={},r="Type alias: MountPropagation",i={id:"type-aliases/MountPropagation",title:"Type alias: MountPropagation",description:'MountPropagation: "private" \\| "rprivate" \\| "shared" \\| "rshared" \\| "slave" \\| "rslave"',source:"@site/api/type-aliases/MountPropagation.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountPropagation",permalink:"/api/type-aliases/MountPropagation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"},next:{title:"MountType",permalink:"/api/type-aliases/MountType"}},c={},p=[{value:"Source",id:"source",level:2}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mountpropagation",children:"Type alias: MountPropagation"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(t.code,{children:'"private"'})," | ",(0,o.jsx)(t.code,{children:'"rprivate"'})," | ",(0,o.jsx)(t.code,{children:'"shared"'})," | ",(0,o.jsx)(t.code,{children:'"rshared"'})," | ",(0,o.jsx)(t.code,{children:'"slave"'})," | ",(0,o.jsx)(t.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>r});var o=n(27378);const a={},s=o.createContext(a);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{96129:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>i,toc:()=>p});var o=n(24246),a=n(71670);const s={},r="Type alias: MountPropagation",i={id:"type-aliases/MountPropagation",title:"Type alias: MountPropagation",description:'MountPropagation: "private" \\| "rprivate" \\| "shared" \\| "rshared" \\| "slave" \\| "rslave"',source:"@site/api/type-aliases/MountPropagation.md",sourceDirName:"type-aliases",slug:"/type-aliases/MountPropagation",permalink:"/api/type-aliases/MountPropagation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountConsistency",permalink:"/api/type-aliases/MountConsistency"},next:{title:"MountType",permalink:"/api/type-aliases/MountType"}},c={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h1,{id:"type-alias-mountpropagation",children:"Type alias: MountPropagation"}),"\n",(0,o.jsxs)(t.blockquote,{children:["\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.strong,{children:"MountPropagation"}),": ",(0,o.jsx)(t.code,{children:'"private"'})," | ",(0,o.jsx)(t.code,{children:'"rprivate"'})," | ",(0,o.jsx)(t.code,{children:'"shared"'})," | ",(0,o.jsx)(t.code,{children:'"rshared"'})," | ",(0,o.jsx)(t.code,{children:'"slave"'})," | ",(0,o.jsx)(t.code,{children:'"rslave"'})]}),"\n"]}),"\n",(0,o.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2131",children:"packages/extension-api/src/extension-api.d.ts:2131"})})]})}function d(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>r});var o=n(27378);const a={},s=o.createContext(a);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d496897e.5ca64b57.js b/assets/js/d496897e.9b4c8363.js similarity index 96% rename from assets/js/d496897e.5ca64b57.js rename to assets/js/d496897e.9b4c8363.js index b03909aece9..80afd57744d 100644 --- a/assets/js/d496897e.5ca64b57.js +++ b/assets/js/d496897e.9b4c8363.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{65290:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),c=t(71670);const r={},i="Function: createPod()",o={id:"namespaces/containerEngine/functions/createPod",title:"Function: createPod()",description:"createPod(podOptions): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createPod",permalink:"/api/namespaces/containerEngine/functions/createPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork"},next:{title:"createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createPod"}),"(",(0,s.jsx)(n.code,{children:"podOptions"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podOptions"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,s.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3413",children:"packages/extension-api/src/extension-api.d.ts:3413"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{65290:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),c=t(71670);const r={},i="Function: createPod()",o={id:"namespaces/containerEngine/functions/createPod",title:"Function: createPod()",description:"createPod(podOptions): Promise\\",source:"@site/api/namespaces/containerEngine/functions/createPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/createPod",permalink:"/api/namespaces/containerEngine/functions/createPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createNetwork",permalink:"/api/namespaces/containerEngine/functions/createNetwork"},next:{title:"createVolume",permalink:"/api/namespaces/containerEngine/functions/createVolume"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Id",id:"id",level:3},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createPod"}),"(",(0,s.jsx)(n.code,{children:"podOptions"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"podOptions"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,s.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"Id"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3413",children:"packages/extension-api/src/extension-api.d.ts:3413"})})]})}function p(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>o,a:()=>i});var s=t(27378);const c={},r=s.createContext(c);function i(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d66cbd9e.578cefbf.js b/assets/js/d66cbd9e.04d75988.js similarity index 90% rename from assets/js/d66cbd9e.578cefbf.js rename to assets/js/d66cbd9e.04d75988.js index 35ace5e07fd..b205f369b14 100644 --- a/assets/js/d66cbd9e.578cefbf.js +++ b/assets/js/d66cbd9e.04d75988.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{85385:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),s=r(71670);const i={},o="Interface: Port",c={id:"interfaces/Port",title:"Interface: Port",description:"Properties",source:"@site/api/interfaces/Port.md",sourceDirName:"interfaces",slug:"/interfaces/Port",permalink:"/api/interfaces/Port",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"},next:{title:"PortBinding",permalink:"/api/interfaces/PortBinding"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Source",id:"source",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Source",id:"source-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Source",id:"source-2",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2056",children:"packages/extension-api/src/extension-api.d.ts:2056"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"privateport",children:"PrivatePort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PrivatePort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"publicport",children:"PublicPort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PublicPort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2058",children:"packages/extension-api/src/extension-api.d.ts:2058"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2059",children:"packages/extension-api/src/extension-api.d.ts:2059"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{85385:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=r(24246),s=r(71670);const i={},o="Interface: Port",c={id:"interfaces/Port",title:"Interface: Port",description:"Properties",source:"@site/api/interfaces/Port.md",sourceDirName:"interfaces",slug:"/interfaces/Port",permalink:"/api/interfaces/Port",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions"},next:{title:"PortBinding",permalink:"/api/interfaces/PortBinding"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"IP",id:"ip",level:3},{value:"Source",id:"source",level:4},{value:"PrivatePort",id:"privateport",level:3},{value:"Source",id:"source-1",level:4},{value:"PublicPort",id:"publicport",level:3},{value:"Source",id:"source-2",level:4},{value:"Type",id:"type",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-port",children:"Interface: Port"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"ip",children:"IP"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"IP"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2056",children:"packages/extension-api/src/extension-api.d.ts:2056"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"privateport",children:"PrivatePort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PrivatePort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"publicport",children:"PublicPort"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"PublicPort"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2058",children:"packages/extension-api/src/extension-api.d.ts:2058"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"Type"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Type"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2059",children:"packages/extension-api/src/extension-api.d.ts:2059"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var t=r(27378);const s={},i=t.createContext(s);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d739767a.15a51811.js b/assets/js/d739767a.ee55486a.js similarity index 96% rename from assets/js/d739767a.15a51811.js rename to assets/js/d739767a.ee55486a.js index 91110b74dba..edabba0e1a7 100644 --- a/assets/js/d739767a.15a51811.js +++ b/assets/js/d739767a.ee55486a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{58043:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=s(24246),r=s(71670);const i={},a="Function: onDidChangeTelemetryEnabled()",c={id:"namespaces/env/functions/onDidChangeTelemetryEnabled",title:"Function: onDidChangeTelemetryEnabled()",description:"onDidChangeTelemetryEnabled(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/env/functions/onDidChangeTelemetryEnabled.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"},next:{title:"openExternal",permalink:"/api/namespaces/env/functions/openExternal"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,t.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,t.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3735",children:"packages/extension-api/src/extension-api.d.ts:3735"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const r={},i=t.createContext(r);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{58043:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var t=s(24246),r=s(71670);const i={},a="Function: onDidChangeTelemetryEnabled()",c={id:"namespaces/env/functions/onDidChangeTelemetryEnabled",title:"Function: onDidChangeTelemetryEnabled()",description:"onDidChangeTelemetryEnabled(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/env/functions/onDidChangeTelemetryEnabled.md",sourceDirName:"namespaces/env/functions",slug:"/namespaces/env/functions/onDidChangeTelemetryEnabled",permalink:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"createTelemetryLogger",permalink:"/api/namespaces/env/functions/createTelemetryLogger"},next:{title:"openExternal",permalink:"/api/namespaces/env/functions/openExternal"}},o={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-ondidchangetelemetryenabled",children:"Function: onDidChangeTelemetryEnabled()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"onDidChangeTelemetryEnabled"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["An ",(0,t.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires when the user enabled or disables telemetry.\n",(0,t.jsx)(n.code,{children:"true"})," if the user has enabled telemetry or ",(0,t.jsx)(n.code,{children:"false"})," if the user has disabled telemetry."]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3735",children:"packages/extension-api/src/extension-api.d.ts:3735"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>a});var t=s(27378);const r={},i=t.createContext(r);function a(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d83f208d.d23925bd.js b/assets/js/d83f208d.5df760c7.js similarity index 87% rename from assets/js/d83f208d.d23925bd.js rename to assets/js/d83f208d.5df760c7.js index e13fbe5d183..400113e86f0 100644 --- a/assets/js/d83f208d.d23925bd.js +++ b/assets/js/d83f208d.5df760c7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{30245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var i=s(24246),c=s(71670);const r={},o="Interface: RunOptions",t={id:"interfaces/RunOptions",title:"Interface: RunOptions",description:"Options for running a command.",source:"@site/api/interfaces/RunOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RunOptions",permalink:"/api/interfaces/RunOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunError",permalink:"/api/interfaces/RunError"},next:{title:"RunResult",permalink:"/api/interfaces/RunResult"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Source",id:"source",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Source",id:"source-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Source",id:"source-4",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cwd"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"custom directory"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3782",children:"packages/extension-api/src/extension-api.d.ts:3782"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3792",children:"packages/extension-api/src/extension-api.d.ts:3792"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment variables to set for the command."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3767",children:"packages/extension-api/src/extension-api.d.ts:3767"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isAdmin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logger",children:"logger?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logger"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3777",children:"packages/extension-api/src/extension-api.d.ts:3777"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"token"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3772",children:"packages/extension-api/src/extension-api.d.ts:3772"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{30245:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const r={},o="Interface: RunOptions",t={id:"interfaces/RunOptions",title:"Interface: RunOptions",description:"Options for running a command.",source:"@site/api/interfaces/RunOptions.md",sourceDirName:"interfaces",slug:"/interfaces/RunOptions",permalink:"/api/interfaces/RunOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RunError",permalink:"/api/interfaces/RunError"},next:{title:"RunResult",permalink:"/api/interfaces/RunResult"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"cwd?",id:"cwd",level:3},{value:"Source",id:"source",level:4},{value:"encoding?",id:"encoding",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"isAdmin?",id:"isadmin",level:3},{value:"Source",id:"source-3",level:4},{value:"logger?",id:"logger",level:3},{value:"Source",id:"source-4",level:4},{value:"token?",id:"token",level:3},{value:"Source",id:"source-5",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"}),"\n",(0,i.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"cwd"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"custom directory"}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3782",children:"packages/extension-api/src/extension-api.d.ts:3782"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"encoding"}),": ",(0,i.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3792",children:"packages/extension-api/src/extension-api.d.ts:3792"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Environment variables to set for the command."}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3767",children:"packages/extension-api/src/extension-api.d.ts:3767"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"isAdmin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"admin privileges required"}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logger",children:"logger?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"logger"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,i.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A logger used to track execution events."}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3777",children:"packages/extension-api/src/extension-api.d.ts:3777"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"token",children:"token?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"token"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,i.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"A cancellation token used to request cancellation."}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3772",children:"packages/extension-api/src/extension-api.d.ts:3772"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>o});var i=s(27378);const c={},r=i.createContext(c);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9407a00.276e1097.js b/assets/js/d9407a00.46b475b3.js similarity index 95% rename from assets/js/d9407a00.276e1097.js rename to assets/js/d9407a00.46b475b3.js index a1678f91151..87a66170f16 100644 --- a/assets/js/d9407a00.276e1097.js +++ b/assets/js/d9407a00.46b475b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{70554:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var i=o(24246),s=o(71670);const t={},c="Function: showNotification()",a={id:"namespaces/window/functions/showNotification",title:"Function: showNotification()",description:"showNotification(options): Disposable",source:"@site/api/namespaces/window/functions/showNotification.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showNotification",permalink:"/api/namespaces/window/functions/showNotification",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInputBox",permalink:"/api/namespaces/window/functions/showInputBox"},next:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-shownotification",children:"Function: showNotification()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"showNotification"}),"(",(0,i.jsx)(e.code,{children:"options"}),"): ",(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/NotificationOptions",children:(0,i.jsx)(e.code,{children:"NotificationOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"define how the notification must be created."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1720",children:"packages/extension-api/src/extension-api.d.ts:1720"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>a,a:()=>c});var i=o(27378);const s={},t=i.createContext(s);function c(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{70554:(n,e,o)=>{o.r(e),o.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var i=o(24246),s=o(71670);const t={},c="Function: showNotification()",a={id:"namespaces/window/functions/showNotification",title:"Function: showNotification()",description:"showNotification(options): Disposable",source:"@site/api/namespaces/window/functions/showNotification.md",sourceDirName:"namespaces/window/functions",slug:"/namespaces/window/functions/showNotification",permalink:"/api/namespaces/window/functions/showNotification",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"showInputBox",permalink:"/api/namespaces/window/functions/showInputBox"},next:{title:"showOpenDialog",permalink:"/api/namespaces/window/functions/showOpenDialog"}},r={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-shownotification",children:"Function: showNotification()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"showNotification"}),"(",(0,i.jsx)(e.code,{children:"options"}),"): ",(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/NotificationOptions",children:(0,i.jsx)(e.code,{children:"NotificationOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"define how the notification must be created."}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(e.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1720",children:"packages/extension-api/src/extension-api.d.ts:1720"})})]})}function l(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(p,{...n})}):p(n)}},71670:(n,e,o)=>{o.d(e,{Z:()=>a,a:()=>c});var i=o(27378);const s={},t=i.createContext(s);function c(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:c(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9673b17.21d4c59a.js b/assets/js/d9673b17.476bf1b1.js similarity index 85% rename from assets/js/d9673b17.21d4c59a.js rename to assets/js/d9673b17.476bf1b1.js index 006e4b4376e..45daeb5ed98 100644 --- a/assets/js/d9673b17.21d4c59a.js +++ b/assets/js/d9673b17.476bf1b1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{91590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var t=i(24246),o=i(71670);const s={},c="Interface: NotificationOptions",r={id:"interfaces/NotificationOptions",title:"Interface: NotificationOptions",description:"Properties",source:"@site/api/interfaces/NotificationOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NotificationOptions",permalink:"/api/interfaces/NotificationOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig"},next:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Source",id:"source",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-5",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-notificationoptions",children:"Interface: NotificationOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"body",children:"body?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The body text of the notification, which will be displayed below the title."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1198",children:"packages/extension-api/src/extension-api.d.ts:1198"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"highlight",children:"highlight?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"highlight"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"this notification will be highlighted to the user so it draws attention"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdownactions",children:"markdownActions?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"markdownActions"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"displayed below the description. It contains actions (like markdown commands/buttons and links)"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1210",children:"packages/extension-api/src/extension-api.d.ts:1210"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether or not to emit an OS notification noise when showing the notification."}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1202",children:"packages/extension-api/src/extension-api.d.ts:1202"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A title for the notification, which will be shown at the top of the notification window when it is shown."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1194",children:"packages/extension-api/src/extension-api.d.ts:1194"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/NotificationType",children:(0,t.jsx)(n.code,{children:"NotificationType"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The type of the notification. Default value: info"}),"\n",(0,t.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1206",children:"packages/extension-api/src/extension-api.d.ts:1206"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var t=i(27378);const o={},s=t.createContext(o);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{91590:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>a});var t=i(24246),o=i(71670);const s={},c="Interface: NotificationOptions",r={id:"interfaces/NotificationOptions",title:"Interface: NotificationOptions",description:"Properties",source:"@site/api/interfaces/NotificationOptions.md",sourceDirName:"interfaces",slug:"/interfaces/NotificationOptions",permalink:"/api/interfaces/NotificationOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkingConfig",permalink:"/api/interfaces/NetworkingConfig"},next:{title:"OpenDialogOptions",permalink:"/api/interfaces/OpenDialogOptions"}},l={},a=[{value:"Properties",id:"properties",level:2},{value:"body?",id:"body",level:3},{value:"Source",id:"source",level:4},{value:"highlight?",id:"highlight",level:3},{value:"Source",id:"source-1",level:4},{value:"markdownActions?",id:"markdownactions",level:3},{value:"Source",id:"source-2",level:4},{value:"silent?",id:"silent",level:3},{value:"Source",id:"source-3",level:4},{value:"title?",id:"title",level:3},{value:"Source",id:"source-4",level:4},{value:"type?",id:"type",level:3},{value:"Source",id:"source-5",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-notificationoptions",children:"Interface: NotificationOptions"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"body",children:"body?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"body"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The body text of the notification, which will be displayed below the title."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1198",children:"packages/extension-api/src/extension-api.d.ts:1198"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"highlight",children:"highlight?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"highlight"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"this notification will be highlighted to the user so it draws attention"}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1214",children:"packages/extension-api/src/extension-api.d.ts:1214"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"markdownactions",children:"markdownActions?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"markdownActions"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"displayed below the description. It contains actions (like markdown commands/buttons and links)"}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1210",children:"packages/extension-api/src/extension-api.d.ts:1210"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"silent",children:"silent?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"silent"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Whether or not to emit an OS notification noise when showing the notification."}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1202",children:"packages/extension-api/src/extension-api.d.ts:1202"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A title for the notification, which will be shown at the top of the notification window when it is shown."}),"\n",(0,t.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1194",children:"packages/extension-api/src/extension-api.d.ts:1194"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"type",children:"type?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.a,{href:"/api/type-aliases/NotificationType",children:(0,t.jsx)(n.code,{children:"NotificationType"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The type of the notification. Default value: info"}),"\n",(0,t.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1206",children:"packages/extension-api/src/extension-api.d.ts:1206"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>r,a:()=>c});var t=i(27378);const o={},s=t.createContext(o);function c(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9b4ee1e.706b0bd3.js b/assets/js/d9b4ee1e.9c832e54.js similarity index 82% rename from assets/js/d9b4ee1e.706b0bd3.js rename to assets/js/d9b4ee1e.9c832e54.js index c60bd39f152..f262a97939c 100644 --- a/assets/js/d9b4ee1e.706b0bd3.js +++ b/assets/js/d9b4ee1e.9c832e54.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{41607:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(24246),s=r(71670);const a={},o="Type alias: KubernetesGeneratorSelector",c={id:"type-aliases/KubernetesGeneratorSelector",title:"Type alias: KubernetesGeneratorSelector",description:"KubernetesGeneratorSelector: KubernetesGeneratorType \\| ReadonlyArray \\",source:"@site/api/type-aliases/KubernetesGeneratorSelector.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"},next:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"}},i={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type alias: KubernetesGeneratorSelector"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,n.jsx)(t.code,{children:"ReadonlyArray"})," <",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1867",children:"packages/extension-api/src/extension-api.d.ts:1867"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>o});var n=r(27378);const s={},a=n.createContext(s);function o(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{41607:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(24246),s=r(71670);const o={},a="Type alias: KubernetesGeneratorSelector",c={id:"type-aliases/KubernetesGeneratorSelector",title:"Type alias: KubernetesGeneratorSelector",description:"KubernetesGeneratorSelector: KubernetesGeneratorType \\| ReadonlyArray \\",source:"@site/api/type-aliases/KubernetesGeneratorSelector.md",sourceDirName:"type-aliases",slug:"/type-aliases/KubernetesGeneratorSelector",permalink:"/api/type-aliases/KubernetesGeneratorSelector",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorArgument",permalink:"/api/type-aliases/KubernetesGeneratorArgument"},next:{title:"KubernetesGeneratorType",permalink:"/api/type-aliases/KubernetesGeneratorType"}},i={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-kubernetesgeneratorselector",children:"Type alias: KubernetesGeneratorSelector"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"KubernetesGeneratorSelector"}),": ",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})})," | ",(0,n.jsx)(t.code,{children:"ReadonlyArray"})," <",(0,n.jsx)(t.a,{href:"/api/type-aliases/KubernetesGeneratorType",children:(0,n.jsx)(t.code,{children:"KubernetesGeneratorType"})}),">"]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1867",children:"packages/extension-api/src/extension-api.d.ts:1867"})})]})}function u(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>a});var n=r(27378);const s={},o=n.createContext(s);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/db22fd17.5e669a8c.js b/assets/js/db22fd17.f1b1d125.js similarity index 87% rename from assets/js/db22fd17.5e669a8c.js rename to assets/js/db22fd17.f1b1d125.js index e4bb639de2d..de72f650666 100644 --- a/assets/js/db22fd17.5e669a8c.js +++ b/assets/js/db22fd17.f1b1d125.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{15947:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var n=o(24246),s=o(71670);const i={},a="Type alias: CliToolState",r={id:"type-aliases/CliToolState",title:"Type alias: CliToolState",description:'CliToolState: "registered"',source:"@site/api/type-aliases/CliToolState.md",sourceDirName:"type-aliases",slug:"/type-aliases/CliToolState",permalink:"/api/type-aliases/CliToolState",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},l={},c=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type alias: CliToolState"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"CliToolState"}),": ",(0,n.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,o)=>{o.d(t,{Z:()=>r,a:()=>a});var n=o(27378);const s={},i=n.createContext(s);function a(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{15947:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var n=o(24246),s=o(71670);const i={},a="Type alias: CliToolState",r={id:"type-aliases/CliToolState",title:"Type alias: CliToolState",description:'CliToolState: "registered"',source:"@site/api/type-aliases/CliToolState.md",sourceDirName:"type-aliases",slug:"/type-aliases/CliToolState",permalink:"/api/type-aliases/CliToolState",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CheckResultLink",permalink:"/api/type-aliases/CheckResultLink"},next:{title:"ConfigurationScope",permalink:"/api/type-aliases/ConfigurationScope"}},c={},l=[{value:"Source",id:"source",level:2}];function p(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"type-alias-clitoolstate",children:"Type alias: CliToolState"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"CliToolState"}),": ",(0,n.jsx)(t.code,{children:'"registered"'})]}),"\n"]}),"\n",(0,n.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,t,o)=>{o.d(t,{Z:()=>r,a:()=>a});var n=o(27378);const s={},i=n.createContext(s);function a(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dc23cd40.2fe14e2d.js b/assets/js/dc23cd40.1b419dea.js similarity index 90% rename from assets/js/dc23cd40.2fe14e2d.js rename to assets/js/dc23cd40.1b419dea.js index e2900c50fb4..20a837cf228 100644 --- a/assets/js/dc23cd40.2fe14e2d.js +++ b/assets/js/dc23cd40.1b419dea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{19206:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=s(24246),i=s(71670);const t={},o="Interface: PodCreateOptions",c={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Source",id:"source-2",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-podcreateoptions",children:"Interface: PodCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"labels"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L300",children:"packages/extension-api/src/extension-api.d.ts:300"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"portmappings",children:"portmappings?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"portmappings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/PodCreatePortOptions",children:(0,r.jsx)(n.code,{children:"PodCreatePortOptions"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L301",children:"packages/extension-api/src/extension-api.d.ts:301"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L304",children:"packages/extension-api/src/extension-api.d.ts:304"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{19206:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var r=s(24246),i=s(71670);const t={},o="Interface: PodCreateOptions",c={id:"interfaces/PodCreateOptions",title:"Interface: PodCreateOptions",description:"Properties",source:"@site/api/interfaces/PodCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodCreateOptions",permalink:"/api/interfaces/PodCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodContainerInfo",permalink:"/api/interfaces/PodContainerInfo"},next:{title:"PodCreatePortOptions",permalink:"/api/interfaces/PodCreatePortOptions"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"labels?",id:"labels",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"portmappings?",id:"portmappings",level:3},{value:"Source",id:"source-2",level:4},{value:"provider?",id:"provider",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-podcreateoptions",children:"Interface: PodCreateOptions"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"labels",children:"labels?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"labels"}),": ",(0,r.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,r.jsxs)(n.p,{children:["[",(0,r.jsx)(n.code,{children:"key"}),": ",(0,r.jsx)(n.code,{children:"string"}),"]: ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L300",children:"packages/extension-api/src/extension-api.d.ts:300"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"portmappings",children:"portmappings?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"portmappings"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/PodCreatePortOptions",children:(0,r.jsx)(n.code,{children:"PodCreatePortOptions"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L301",children:"packages/extension-api/src/extension-api.d.ts:301"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"provider",children:"provider?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"provider"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,r.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L304",children:"packages/extension-api/src/extension-api.d.ts:304"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var r=s(27378);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dec87402.d180daa0.js b/assets/js/dec87402.79d0b788.js similarity index 86% rename from assets/js/dec87402.d180daa0.js rename to assets/js/dec87402.79d0b788.js index dbc115af296..5a8860d7a42 100644 --- a/assets/js/dec87402.d180daa0.js +++ b/assets/js/dec87402.79d0b788.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{43570:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>g,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Function: tagImage()",a={id:"namespaces/containerEngine/functions/tagImage",title:"Function: tagImage()",description:"tagImage(engineId, imageId, repo, tag?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/tagImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod"},next:{title:"Namespace: context",permalink:"/api/namespaces/context/"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"tagImage"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"imageId"}),", ",(0,t.jsx)(n.code,{children:"repo"}),", ",(0,t.jsx)(n.code,{children:"tag"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"repo"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,t.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"tag?"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"The name of the new tag"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3332",children:"packages/extension-api/src/extension-api.d.ts:3332"})})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{43570:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>g,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Function: tagImage()",c={id:"namespaces/containerEngine/functions/tagImage",title:"Function: tagImage()",description:"tagImage(engineId, imageId, repo, tag?): Promise\\",source:"@site/api/namespaces/containerEngine/functions/tagImage.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod"},next:{title:"Namespace: context",permalink:"/api/namespaces/context/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-tagimage",children:"Function: tagImage()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"tagImage"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"imageId"}),", ",(0,t.jsx)(n.code,{children:"repo"}),", ",(0,t.jsx)(n.code,{children:"tag"}),"?): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Tag an image so that it becomes part of a repository"}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the engine managing the image, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"imageId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["the id of the image on this engine, obtained from the result of ",(0,t.jsx)(n.a,{href:"/api/namespaces/containerEngine/functions/listImages",children:"containerEngine.listImages"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"repo"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["The repository to tag in. For example, ",(0,t.jsx)(n.code,{children:"someuser/someimage"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"tag?"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"The name of the new tag"}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3332",children:"packages/extension-api/src/extension-api.d.ts:3332"})})]})}function g(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/deccabf3.b2892be8.js b/assets/js/deccabf3.1422a508.js similarity index 91% rename from assets/js/deccabf3.b2892be8.js rename to assets/js/deccabf3.1422a508.js index fe93d788f4f..c7ea1c545a7 100644 --- a/assets/js/deccabf3.b2892be8.js +++ b/assets/js/deccabf3.1422a508.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18880],{50761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const o={},s="Enumeration: InputBoxValidationSeverity",a={id:"enumerations/InputBoxValidationSeverity",title:"Enumeration: InputBoxValidationSeverity",description:"Impacts the behavior and appearance of the validation message.",source:"@site/api/enumerations/InputBoxValidationSeverity.md",sourceDirName:"enumerations",slug:"/enumerations/InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"Info",id:"info",level:3},{value:"Source",id:"source-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-inputboxvalidationseverity",children:"Enumeration: InputBoxValidationSeverity"}),"\n",(0,r.jsx)(n.p,{children:"Impacts the behavior and appearance of the validation message."}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"Error"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Error"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L852",children:"packages/extension-api/src/extension-api.d.ts:852"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"info",children:"Info"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Info"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L850",children:"packages/extension-api/src/extension-api.d.ts:850"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warning",children:"Warning"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Warning"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L851",children:"packages/extension-api/src/extension-api.d.ts:851"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18880],{50761:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var r=i(24246),t=i(71670);const o={},s="Enumeration: InputBoxValidationSeverity",a={id:"enumerations/InputBoxValidationSeverity",title:"Enumeration: InputBoxValidationSeverity",description:"Impacts the behavior and appearance of the validation message.",source:"@site/api/enumerations/InputBoxValidationSeverity.md",sourceDirName:"enumerations",slug:"/enumerations/InputBoxValidationSeverity",permalink:"/api/enumerations/InputBoxValidationSeverity",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"withProgress",permalink:"/api/namespaces/window/functions/withProgress"},next:{title:"ProgressLocation",permalink:"/api/enumerations/ProgressLocation"}},c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"Error",id:"error",level:3},{value:"Source",id:"source",level:4},{value:"Info",id:"info",level:3},{value:"Source",id:"source-1",level:4},{value:"Warning",id:"warning",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"enumeration-inputboxvalidationseverity",children:"Enumeration: InputBoxValidationSeverity"}),"\n",(0,r.jsx)(n.p,{children:"Impacts the behavior and appearance of the validation message."}),"\n",(0,r.jsx)(n.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h3,{id:"error",children:"Error"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Error"}),": ",(0,r.jsx)(n.code,{children:"3"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L852",children:"packages/extension-api/src/extension-api.d.ts:852"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"info",children:"Info"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Info"}),": ",(0,r.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L850",children:"packages/extension-api/src/extension-api.d.ts:850"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"warning",children:"Warning"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Warning"}),": ",(0,r.jsx)(n.code,{children:"2"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L851",children:"packages/extension-api/src/extension-api.d.ts:851"})})]})}function u(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>a,a:()=>s});var r=i(27378);const t={},o=r.createContext(t);function s(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/df2a6e58.74f90660.js b/assets/js/df2a6e58.bf7fc67d.js similarity index 98% rename from assets/js/df2a6e58.74f90660.js rename to assets/js/df2a6e58.bf7fc67d.js index 6a062c840ca..cb1c753979e 100644 --- a/assets/js/df2a6e58.74f90660.js +++ b/assets/js/df2a6e58.bf7fc67d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37683],{95823:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Function: listInfos()",c={id:"namespaces/containerEngine/functions/listInfos",title:"Function: listInfos()",description:"listInfos(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listInfos.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listinfos",children:"Function: listInfos()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listInfos"}),"(",(0,i.jsx)(e.code,{children:"options"}),"?): ",(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,i.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"List the engines information."}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options?"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/ListInfosOptions",children:(0,i.jsx)(e.code,{children:"ListInfosOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"optional options for listing information"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,i.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n",(0,i.jsx)(e.p,{children:"A promise resolving to an array of engine information."}),"\n",(0,i.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"// Example 1: List all engine information when no specific provider is provided.\nconst infos = await listInfos();\nconsole.log(infos);\n"})}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"// Example 2: List information for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst info = await listInfos({ provider: provider.connection });\nconsole.log(info);\n"})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3400",children:"packages/extension-api/src/extension-api.d.ts:3400"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:r(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37683],{95823:(n,e,s)=>{s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Function: listInfos()",c={id:"namespaces/containerEngine/functions/listInfos",title:"Function: listInfos()",description:"listInfos(options?): Promise \\",source:"@site/api/namespaces/containerEngine/functions/listInfos.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/listInfos",permalink:"/api/namespaces/containerEngine/functions/listInfos",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"listImages",permalink:"/api/namespaces/containerEngine/functions/listImages"},next:{title:"listNetworks",permalink:"/api/namespaces/containerEngine/functions/listNetworks"}},a={},l=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Examples",id:"examples",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",strong:"strong",...(0,o.a)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h1,{id:"function-listinfos",children:"Function: listInfos()"}),"\n",(0,i.jsxs)(e.blockquote,{children:["\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.strong,{children:"listInfos"}),"(",(0,i.jsx)(e.code,{children:"options"}),"?): ",(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,i.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n"]}),"\n",(0,i.jsx)(e.p,{children:"List the engines information."}),"\n",(0,i.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options?"}),": ",(0,i.jsx)(e.a,{href:"/api/interfaces/ListInfosOptions",children:(0,i.jsx)(e.code,{children:"ListInfosOptions"})})]}),"\n",(0,i.jsx)(e.p,{children:"optional options for listing information"}),"\n",(0,i.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"Promise"})," <",(0,i.jsx)(e.a,{href:"/api/interfaces/ContainerEngineInfo",children:(0,i.jsx)(e.code,{children:"ContainerEngineInfo"})}),"[]>"]}),"\n",(0,i.jsx)(e.p,{children:"A promise resolving to an array of engine information."}),"\n",(0,i.jsx)(e.h2,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"// Example 1: List all engine information when no specific provider is provided.\nconst infos = await listInfos();\nconsole.log(infos);\n"})}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"// Example 2: List information for a specific provider.\nconst provider = provider.getContainerConnections().find(connection => connection.connection.status() === 'started');\nconst info = await listInfos({ provider: provider.connection });\nconsole.log(info);\n"})}),"\n",(0,i.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3400",children:"packages/extension-api/src/extension-api.d.ts:3400"})})]})}function p(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(d,{...n})}):d(n)}},71670:(n,e,s)=>{s.d(e,{Z:()=>c,a:()=>r});var i=s(27378);const o={},t=i.createContext(o);function r(n){const e=i.useContext(t);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:r(n.components),i.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/df4d464e.55c18137.js b/assets/js/df4d464e.841bfeb0.js similarity index 77% rename from assets/js/df4d464e.55c18137.js rename to assets/js/df4d464e.841bfeb0.js index 4406f6c25ac..ec5537d98fb 100644 --- a/assets/js/df4d464e.55c18137.js +++ b/assets/js/df4d464e.841bfeb0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{73050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>u});var t=s(24246),r=s(71670);const c={},i="Function: setKubeconfig()",o={id:"namespaces/kubernetes/functions/setKubeconfig",title:"Function: setKubeconfig()",description:"setKubeconfig(kubeconfig): Promise\\",source:"@site/api/namespaces/kubernetes/functions/setKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"},next:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1842",children:"packages/extension-api/src/extension-api.d.ts:1842"})})]})}function l(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const r={},c=t.createContext(r);function i(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{73050:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>u});var t=s(24246),c=s(71670);const r={},i="Function: setKubeconfig()",o={id:"namespaces/kubernetes/functions/setKubeconfig",title:"Function: setKubeconfig()",description:"setKubeconfig(kubeconfig): Promise\\",source:"@site/api/namespaces/kubernetes/functions/setKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/setKubeconfig",permalink:"/api/namespaces/kubernetes/functions/setKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"},next:{title:"Namespace: navigation",permalink:"/api/namespaces/navigation/"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setkubeconfig",children:"Function: setKubeconfig()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setKubeconfig"}),"(",(0,t.jsx)(n.code,{children:"kubeconfig"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"kubeconfig"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1842",children:"packages/extension-api/src/extension-api.d.ts:1842"})})]})}function l(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>i});var t=s(27378);const c={},r=t.createContext(c);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e064f6d4.d0db90a8.js b/assets/js/e064f6d4.1d93c541.js similarity index 93% rename from assets/js/e064f6d4.d0db90a8.js rename to assets/js/e064f6d4.1d93c541.js index da7596bbb85..ae3439256f5 100644 --- a/assets/js/e064f6d4.d0db90a8.js +++ b/assets/js/e064f6d4.1d93c541.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{62854:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const r={},c="Interface: ContainerInspectInfo",l={id:"interfaces/ContainerInspectInfo",title:"Interface: ContainerInspectInfo",description:"Properties",source:"@site/api/interfaces/ContainerInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerInfo",permalink:"/api/interfaces/ContainerInfo"},next:{title:"ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"AppArmorProfile",id:"apparmorprofile",level:3},{value:"Source",id:"source",level:4},{value:"Args",id:"args",level:3},{value:"Source",id:"source-1",level:4},{value:"Config",id:"config",level:3},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild?",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-2",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Source",id:"source-5",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Source",id:"source-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Source",id:"source-9",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Source",id:"source-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Source",id:"source-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Source",id:"source-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Source",id:"source-15",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Bridge",id:"bridge",level:4},{value:"EndpointID",id:"endpointid",level:4},{value:"Gateway",id:"gateway",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:4},{value:"HairpinMode",id:"hairpinmode",level:4},{value:"IPAddress",id:"ipaddress",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:4},{value:"LinkLocalIPv6Address",id:"linklocalipv6address",level:4},{value:"LinkLocalIPv6PrefixLen",id:"linklocalipv6prefixlen",level:4},{value:"MacAddress",id:"macaddress",level:4},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Node?",id:"node",level:4},{value:"Node.Addr",id:"nodeaddr",level:4},{value:"Node.Cpus",id:"nodecpus",level:4},{value:"Node.ID",id:"nodeid",level:4},{value:"Node.IP",id:"nodeip",level:4},{value:"Node.Labels",id:"nodelabels",level:4},{value:"Node.Memory",id:"nodememory",level:4},{value:"Node.Name",id:"nodename",level:4},{value:"Ports",id:"ports",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"SandboxID",id:"sandboxid",level:4},{value:"SandboxKey",id:"sandboxkey",level:4},{value:"SecondaryIPAddresses?",id:"secondaryipaddresses",level:4},{value:"SecondaryIPv6Addresses?",id:"secondaryipv6addresses",level:4},{value:"Source",id:"source-16",level:4},{value:"Path",id:"path",level:3},{value:"Source",id:"source-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Source",id:"source-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Source",id:"source-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Source",id:"source-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Source",id:"source-21",level:4},{value:"State",id:"state",level:3},{value:"Dead",id:"dead",level:4},{value:"Error",id:"error",level:4},{value:"ExitCode",id:"exitcode",level:4},{value:"FinishedAt",id:"finishedat",level:4},{value:"Health?",id:"health",level:4},{value:"OOMKilled",id:"oomkilled",level:4},{value:"Paused",id:"paused",level:4},{value:"Pid",id:"pid",level:4},{value:"Restarting",id:"restarting",level:4},{value:"Running",id:"running",level:4},{value:"StartedAt",id:"startedat",level:4},{value:"Status",id:"status",level:4},{value:"Source",id:"source-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-24",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Args"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2286",children:"packages/extension-api/src/extension-api.d.ts:2286"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2284",children:"packages/extension-api/src/extension-api.d.ts:2284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2308",children:"packages/extension-api/src/extension-api.d.ts:2308"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExecIDs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2313",children:"packages/extension-api/src/extension-api.d.ts:2313"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2315",children:"packages/extension-api/src/extension-api.d.ts:2315"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2314",children:"packages/extension-api/src/extension-api.d.ts:2314"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2303",children:"packages/extension-api/src/extension-api.d.ts:2303"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2304",children:"packages/extension-api/src/extension-api.d.ts:2304"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2283",children:"packages/extension-api/src/extension-api.d.ts:2283"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2301",children:"packages/extension-api/src/extension-api.d.ts:2301"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LogPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2305",children:"packages/extension-api/src/extension-api.d.ts:2305"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MountLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2310",children:"packages/extension-api/src/extension-api.d.ts:2310"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2323",children:"packages/extension-api/src/extension-api.d.ts:2323"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name-1",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2306",children:"packages/extension-api/src/extension-api.d.ts:2306"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Bridge"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"node",children:"Node?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Node"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Addr"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeid",children:"Node.ID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeip",children:"Node.IP"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IP"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodename",children:"Node.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPAddresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPv6Addresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2351",children:"packages/extension-api/src/extension-api.d.ts:2351"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2285",children:"packages/extension-api/src/extension-api.d.ts:2285"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2309",children:"packages/extension-api/src/extension-api.d.ts:2309"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2311",children:"packages/extension-api/src/extension-api.d.ts:2311"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2302",children:"packages/extension-api/src/extension-api.d.ts:2302"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RestartCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2307",children:"packages/extension-api/src/extension-api.d.ts:2307"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Dead"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"error",children:"Error"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Error"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exitcode",children:"ExitCode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExitCode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"health",children:"Health?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Health"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,i.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Paused"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Pid"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Restarting"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Running"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StartedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2287",children:"packages/extension-api/src/extension-api.d.ts:2287"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2281",children:"packages/extension-api/src/extension-api.d.ts:2281"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})})]})}function h(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>c});var i=s(27378);const d={},r=i.createContext(d);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{62854:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const r={},c="Interface: ContainerInspectInfo",l={id:"interfaces/ContainerInspectInfo",title:"Interface: ContainerInspectInfo",description:"Properties",source:"@site/api/interfaces/ContainerInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerInspectInfo",permalink:"/api/interfaces/ContainerInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerInfo",permalink:"/api/interfaces/ContainerInfo"},next:{title:"ContainerJSONEvent",permalink:"/api/interfaces/ContainerJSONEvent"}},o={},t=[{value:"Properties",id:"properties",level:2},{value:"AppArmorProfile",id:"apparmorprofile",level:3},{value:"Source",id:"source",level:4},{value:"Args",id:"args",level:3},{value:"Source",id:"source-1",level:4},{value:"Config",id:"config",level:3},{value:"AttachStderr",id:"attachstderr",level:4},{value:"AttachStdin",id:"attachstdin",level:4},{value:"AttachStdout",id:"attachstdout",level:4},{value:"Cmd",id:"cmd",level:4},{value:"Domainname",id:"domainname",level:4},{value:"Entrypoint?",id:"entrypoint",level:4},{value:"Env",id:"env",level:4},{value:"ExposedPorts",id:"exposedports",level:4},{value:"Index signature",id:"index-signature",level:5},{value:"Hostname",id:"hostname",level:4},{value:"Image",id:"image",level:4},{value:"Labels",id:"labels",level:4},{value:"Index signature",id:"index-signature-1",level:5},{value:"OnBuild?",id:"onbuild",level:4},{value:"OpenStdin",id:"openstdin",level:4},{value:"StdinOnce",id:"stdinonce",level:4},{value:"Tty",id:"tty",level:4},{value:"User",id:"user",level:4},{value:"Volumes",id:"volumes",level:4},{value:"Index signature",id:"index-signature-2",level:5},{value:"WorkingDir",id:"workingdir",level:4},{value:"Source",id:"source-2",level:4},{value:"Created",id:"created",level:3},{value:"Source",id:"source-3",level:4},{value:"Driver",id:"driver",level:3},{value:"Source",id:"source-4",level:4},{value:"ExecIDs?",id:"execids",level:3},{value:"Source",id:"source-5",level:4},{value:"GraphDriver",id:"graphdriver",level:3},{value:"Data",id:"data",level:4},{value:"Data.DeviceId",id:"datadeviceid",level:4},{value:"Data.DeviceName",id:"datadevicename",level:4},{value:"Data.DeviceSize",id:"datadevicesize",level:4},{value:"Name",id:"name",level:4},{value:"Source",id:"source-6",level:4},{value:"HostConfig",id:"hostconfig",level:3},{value:"Source",id:"source-7",level:4},{value:"HostnamePath",id:"hostnamepath",level:3},{value:"Source",id:"source-8",level:4},{value:"HostsPath",id:"hostspath",level:3},{value:"Source",id:"source-9",level:4},{value:"Id",id:"id",level:3},{value:"Source",id:"source-10",level:4},{value:"Image",id:"image-1",level:3},{value:"Source",id:"source-11",level:4},{value:"LogPath",id:"logpath",level:3},{value:"Source",id:"source-12",level:4},{value:"MountLabel",id:"mountlabel",level:3},{value:"Source",id:"source-13",level:4},{value:"Mounts",id:"mounts",level:3},{value:"Source",id:"source-14",level:4},{value:"Name",id:"name-1",level:3},{value:"Source",id:"source-15",level:4},{value:"NetworkSettings",id:"networksettings",level:3},{value:"Bridge",id:"bridge",level:4},{value:"EndpointID",id:"endpointid",level:4},{value:"Gateway",id:"gateway",level:4},{value:"GlobalIPv6Address",id:"globalipv6address",level:4},{value:"GlobalIPv6PrefixLen",id:"globalipv6prefixlen",level:4},{value:"HairpinMode",id:"hairpinmode",level:4},{value:"IPAddress",id:"ipaddress",level:4},{value:"IPPrefixLen",id:"ipprefixlen",level:4},{value:"IPv6Gateway",id:"ipv6gateway",level:4},{value:"LinkLocalIPv6Address",id:"linklocalipv6address",level:4},{value:"LinkLocalIPv6PrefixLen",id:"linklocalipv6prefixlen",level:4},{value:"MacAddress",id:"macaddress",level:4},{value:"Networks",id:"networks",level:4},{value:"Index signature",id:"index-signature-3",level:5},{value:"Node?",id:"node",level:4},{value:"Node.Addr",id:"nodeaddr",level:4},{value:"Node.Cpus",id:"nodecpus",level:4},{value:"Node.ID",id:"nodeid",level:4},{value:"Node.IP",id:"nodeip",level:4},{value:"Node.Labels",id:"nodelabels",level:4},{value:"Node.Memory",id:"nodememory",level:4},{value:"Node.Name",id:"nodename",level:4},{value:"Ports",id:"ports",level:4},{value:"Index signature",id:"index-signature-4",level:5},{value:"SandboxID",id:"sandboxid",level:4},{value:"SandboxKey",id:"sandboxkey",level:4},{value:"SecondaryIPAddresses?",id:"secondaryipaddresses",level:4},{value:"SecondaryIPv6Addresses?",id:"secondaryipv6addresses",level:4},{value:"Source",id:"source-16",level:4},{value:"Path",id:"path",level:3},{value:"Source",id:"source-17",level:4},{value:"Platform",id:"platform",level:3},{value:"Source",id:"source-18",level:4},{value:"ProcessLabel",id:"processlabel",level:3},{value:"Source",id:"source-19",level:4},{value:"ResolvConfPath",id:"resolvconfpath",level:3},{value:"Source",id:"source-20",level:4},{value:"RestartCount",id:"restartcount",level:3},{value:"Source",id:"source-21",level:4},{value:"State",id:"state",level:3},{value:"Dead",id:"dead",level:4},{value:"Error",id:"error",level:4},{value:"ExitCode",id:"exitcode",level:4},{value:"FinishedAt",id:"finishedat",level:4},{value:"Health?",id:"health",level:4},{value:"OOMKilled",id:"oomkilled",level:4},{value:"Paused",id:"paused",level:4},{value:"Pid",id:"pid",level:4},{value:"Restarting",id:"restarting",level:4},{value:"Running",id:"running",level:4},{value:"StartedAt",id:"startedat",level:4},{value:"Status",id:"status",level:4},{value:"Source",id:"source-22",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-23",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-24",level:4}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",strong:"strong",...(0,d.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-containerinspectinfo",children:"Interface: ContainerInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"apparmorprofile",children:"AppArmorProfile"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AppArmorProfile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"args",children:"Args"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Args"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2286",children:"packages/extension-api/src/extension-api.d.ts:2286"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstderr",children:"AttachStderr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStderr"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdin",children:"AttachStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"attachstdout",children:"AttachStdout"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"AttachStdout"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"cmd",children:"Cmd"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cmd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"domainname",children:"Domainname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Domainname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"entrypoint",children:"Entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"env",children:"Env"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Env"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exposedports",children:"ExposedPorts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExposedPorts"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"hostname",children:"Hostname"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"image",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"labels",children:"Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"label"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"onbuild",children:"OnBuild?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OnBuild"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"openstdin",children:"OpenStdin"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OpenStdin"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"stdinonce",children:"StdinOnce"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StdinOnce"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"tty",children:"Tty"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Tty"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"user",children:"User"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"User"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"volumes",children:"Volumes"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Volumes"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"volume"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h4,{id:"workingdir",children:"WorkingDir"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"WorkingDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Created"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2284",children:"packages/extension-api/src/extension-api.d.ts:2284"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Driver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2308",children:"packages/extension-api/src/extension-api.d.ts:2308"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"execids",children:"ExecIDs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExecIDs"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2313",children:"packages/extension-api/src/extension-api.d.ts:2313"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"graphdriver",children:"GraphDriver"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GraphDriver"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"data",children:"Data"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Data"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadeviceid",children:"Data.DeviceId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicename",children:"Data.DeviceName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"datadevicesize",children:"Data.DeviceSize"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"DeviceSize"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"name",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2315",children:"packages/extension-api/src/extension-api.d.ts:2315"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostConfig"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostConfig",children:(0,i.jsx)(n.code,{children:"HostConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2314",children:"packages/extension-api/src/extension-api.d.ts:2314"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostnamepath",children:"HostnamePath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostnamePath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2303",children:"packages/extension-api/src/extension-api.d.ts:2303"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostspath",children:"HostsPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HostsPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2304",children:"packages/extension-api/src/extension-api.d.ts:2304"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2283",children:"packages/extension-api/src/extension-api.d.ts:2283"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image-1",children:"Image"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2301",children:"packages/extension-api/src/extension-api.d.ts:2301"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logpath",children:"LogPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LogPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2305",children:"packages/extension-api/src/extension-api.d.ts:2305"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mountlabel",children:"MountLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MountLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2310",children:"packages/extension-api/src/extension-api.d.ts:2310"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2323",children:"packages/extension-api/src/extension-api.d.ts:2323"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name-1",children:"Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2306",children:"packages/extension-api/src/extension-api.d.ts:2306"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"bridge",children:"Bridge"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Bridge"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"endpointid",children:"EndpointID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"EndpointID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"gateway",children:"Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"hairpinmode",children:"HairpinMode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"HairpinMode"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipaddress",children:"IPAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6address",children:"LinkLocalIPv6Address"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6Address"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"linklocalipv6prefixlen",children:"LinkLocalIPv6PrefixLen"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"LinkLocalIPv6PrefixLen"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"macaddress",children:"MacAddress"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"MacAddress"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Networks"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-3",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"})]}),"\n",(0,i.jsx)(n.h4,{id:"node",children:"Node?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Node"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeaddr",children:"Node.Addr"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Addr"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodecpus",children:"Node.Cpus"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Cpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeid",children:"Node.ID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodeip",children:"Node.IP"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"IP"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodelabels",children:"Node.Labels"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Labels"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodememory",children:"Node.Memory"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"nodename",children:"Node.Name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"ports",children:"Ports"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Ports"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h5,{id:"index-signature-4",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"portAndProtocol"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxid",children:"SandboxID"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxID"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"sandboxkey",children:"SandboxKey"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"SandboxKey"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipaddresses",children:"SecondaryIPAddresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPAddresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"secondaryipv6addresses",children:"SecondaryIPv6Addresses?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecondaryIPv6Addresses"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2351",children:"packages/extension-api/src/extension-api.d.ts:2351"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"path",children:"Path"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Path"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2285",children:"packages/extension-api/src/extension-api.d.ts:2285"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"platform",children:"Platform"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Platform"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2309",children:"packages/extension-api/src/extension-api.d.ts:2309"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"processlabel",children:"ProcessLabel"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ProcessLabel"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2311",children:"packages/extension-api/src/extension-api.d.ts:2311"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"resolvconfpath",children:"ResolvConfPath"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ResolvConfPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2302",children:"packages/extension-api/src/extension-api.d.ts:2302"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartcount",children:"RestartCount"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"RestartCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2307",children:"packages/extension-api/src/extension-api.d.ts:2307"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"State"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"dead",children:"Dead"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Dead"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"error",children:"Error"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Error"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"exitcode",children:"ExitCode"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"ExitCode"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"finishedat",children:"FinishedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"FinishedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"health",children:"Health?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Health"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HealthCheckResults",children:(0,i.jsx)(n.code,{children:"HealthCheckResults"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"oomkilled",children:"OOMKilled"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"OOMKilled"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"paused",children:"Paused"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Paused"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"pid",children:"Pid"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Pid"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"restarting",children:"Restarting"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Restarting"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"running",children:"Running"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Running"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"startedat",children:"StartedAt"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"StartedAt"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"status",children:"Status"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Status"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2287",children:"packages/extension-api/src/extension-api.d.ts:2287"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2281",children:"packages/extension-api/src/extension-api.d.ts:2281"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})})]})}function a(e={}){const{wrapper:n}={...(0,d.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>c});var i=s(27378);const d={},r=i.createContext(d);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1a2ab10.b2255b83.js b/assets/js/e1a2ab10.905d2fac.js similarity index 96% rename from assets/js/e1a2ab10.b2255b83.js rename to assets/js/e1a2ab10.905d2fac.js index 84cdafbbddc..f6dd11543b6 100644 --- a/assets/js/e1a2ab10.b2255b83.js +++ b/assets/js/e1a2ab10.905d2fac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{85699:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: ProviderInstallation",o={id:"interfaces/ProviderInstallation",title:"Interface: ProviderInstallation",description:"Methods",source:"@site/api/interfaces/ProviderInstallation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"},next:{title:"ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"}},l={},a=[{value:"Methods",id:"methods",level:2},{value:"install()",id:"install",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"install"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L414",children:"packages/extension-api/src/extension-api.d.ts:414"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{85699:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var s=r(24246),t=r(71670);const i={},c="Interface: ProviderInstallation",o={id:"interfaces/ProviderInstallation",title:"Interface: ProviderInstallation",description:"Methods",source:"@site/api/interfaces/ProviderInstallation.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderInstallation",permalink:"/api/interfaces/ProviderInstallation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderInformation",permalink:"/api/interfaces/ProviderInformation"},next:{title:"ProviderLifecycle",permalink:"/api/interfaces/ProviderLifecycle"}},l={},a=[{value:"Methods",id:"methods",level:2},{value:"install()",id:"install",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerinstallation",children:"Interface: ProviderInstallation"}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"install",children:"install()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"install"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L414",children:"packages/extension-api/src/extension-api.d.ts:414"})})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e1c8d71f.7ace300b.js b/assets/js/e1c8d71f.854c1bab.js similarity index 97% rename from assets/js/e1c8d71f.7ace300b.js rename to assets/js/e1c8d71f.854c1bab.js index ff697e6d983..dedb5f32a16 100644 --- a/assets/js/e1c8d71f.7ace300b.js +++ b/assets/js/e1c8d71f.854c1bab.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{26461:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountType",permalink:"/api/type-aliases/MountType"},next:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1188",children:"packages/extension-api/src/extension-api.d.ts:1188"})})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{26461:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var i=n(24246),o=n(71670);const s={},a="Type alias: NotificationType",c={id:"type-aliases/NotificationType",title:"Type alias: NotificationType",description:'NotificationType: "info" \\| "warn" \\| "error"',source:"@site/api/type-aliases/NotificationType.md",sourceDirName:"type-aliases",slug:"/type-aliases/NotificationType",permalink:"/api/type-aliases/NotificationType",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"MountType",permalink:"/api/type-aliases/MountType"},next:{title:"ProviderConnectionStatus",permalink:"/api/type-aliases/ProviderConnectionStatus"}},r={},p=[{value:"Source",id:"source",level:2}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"type-alias-notificationtype",children:"Type alias: NotificationType"}),"\n",(0,i.jsxs)(t.blockquote,{children:["\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"NotificationType"}),": ",(0,i.jsx)(t.code,{children:'"info"'})," | ",(0,i.jsx)(t.code,{children:'"warn"'})," | ",(0,i.jsx)(t.code,{children:'"error"'})]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1188",children:"packages/extension-api/src/extension-api.d.ts:1188"})})]})}function d(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var i=n(27378);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e35d7c3e.e2f7ed9c.js b/assets/js/e35d7c3e.3e09c0dd.js similarity index 86% rename from assets/js/e35d7c3e.e2f7ed9c.js rename to assets/js/e35d7c3e.3e09c0dd.js index 0d8e0084523..b2576de9a21 100644 --- a/assets/js/e35d7c3e.e2f7ed9c.js +++ b/assets/js/e35d7c3e.3e09c0dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{72873:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var n=r(24246),s=r(71670);const o={},i="Interface: NetworkCreateResult",c={id:"interfaces/NetworkCreateResult",title:"Interface: NetworkCreateResult",description:"Properties",source:"@site/api/interfaces/NetworkCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"},next:{title:"NetworkInfo",permalink:"/api/interfaces/NetworkInfo"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Id"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3089",children:"packages/extension-api/src/extension-api.d.ts:3089"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>i});var n=r(27378);const s={},o=n.createContext(s);function i(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{72873:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(24246),s=r(71670);const o={},i="Interface: NetworkCreateResult",c={id:"interfaces/NetworkCreateResult",title:"Interface: NetworkCreateResult",description:"Properties",source:"@site/api/interfaces/NetworkCreateResult.md",sourceDirName:"interfaces",slug:"/interfaces/NetworkCreateResult",permalink:"/api/interfaces/NetworkCreateResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"NetworkCreateOptions",permalink:"/api/interfaces/NetworkCreateOptions"},next:{title:"NetworkInfo",permalink:"/api/interfaces/NetworkInfo"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"Id",id:"id",level:3},{value:"Source",id:"source",level:4}];function d(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"interface-networkcreateresult",children:"Interface: NetworkCreateResult"}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"id",children:"Id"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Id"}),": ",(0,n.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3089",children:"packages/extension-api/src/extension-api.d.ts:3089"})})]})}function p(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>i});var n=r(27378);const s={},o=n.createContext(s);function i(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e38c422a.cb421252.js b/assets/js/e38c422a.ee333fbd.js similarity index 97% rename from assets/js/e38c422a.cb421252.js rename to assets/js/e38c422a.ee333fbd.js index 6ee8b371f82..a6112c7cd0a 100644 --- a/assets/js/e38c422a.cb421252.js +++ b/assets/js/e38c422a.ee333fbd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{10097:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>c,toc:()=>u});var o=i(24246),t=i(71670);const r={},s="Function: getConfiguration()",c={id:"namespaces/configuration/functions/getConfiguration",title:"Function: getConfiguration()",description:"getConfiguration(section?, scope?): Configuration",source:"@site/api/namespaces/configuration/functions/getConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"},next:{title:"onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,o.jsx)(e.code,{children:"section"}),"?, ",(0,o.jsx)(e.code,{children:"scope"}),"?): ",(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"section?"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"scope?"}),": ",(0,o.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,o.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L689",children:"packages/extension-api/src/extension-api.d.ts:689"})})]})}function f(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>s});var o=i(27378);const t={},r=o.createContext(t);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{10097:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>s,default:()=>f,frontMatter:()=>r,metadata:()=>c,toc:()=>u});var o=i(24246),t=i(71670);const r={},s="Function: getConfiguration()",c={id:"namespaces/configuration/functions/getConfiguration",title:"Function: getConfiguration()",description:"getConfiguration(section?, scope?): Configuration",source:"@site/api/namespaces/configuration/functions/getConfiguration.md",sourceDirName:"namespaces/configuration/functions",slug:"/namespaces/configuration/functions/getConfiguration",permalink:"/api/namespaces/configuration/functions/getConfiguration",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: configuration",permalink:"/api/namespaces/configuration/"},next:{title:"onDidChangeConfiguration",permalink:"/api/namespaces/configuration/functions/onDidChangeConfiguration"}},a={},u=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-getconfiguration",children:"Function: getConfiguration()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"getConfiguration"}),"(",(0,o.jsx)(e.code,{children:"section"}),"?, ",(0,o.jsx)(e.code,{children:"scope"}),"?): ",(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"section?"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"scope?"}),": ",(0,o.jsx)(e.a,{href:"/api/type-aliases/ConfigurationScope",children:(0,o.jsx)(e.code,{children:"ConfigurationScope"})})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"/api/interfaces/Configuration",children:(0,o.jsx)(e.code,{children:"Configuration"})})}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L689",children:"packages/extension-api/src/extension-api.d.ts:689"})})]})}function f(n={}){const{wrapper:e}={...(0,t.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},71670:(n,e,i)=>{i.d(e,{Z:()=>c,a:()=>s});var o=i(27378);const t={},r=o.createContext(t);function s(n){const e=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),o.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/e3f28bf9.407bd79c.js b/assets/js/e3f28bf9.e56187d1.js similarity index 94% rename from assets/js/e3f28bf9.407bd79c.js rename to assets/js/e3f28bf9.e56187d1.js index 518f6db4e65..51fa0d79cb0 100644 --- a/assets/js/e3f28bf9.407bd79c.js +++ b/assets/js/e3f28bf9.e56187d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{33712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L570",children:"packages/extension-api/src/extension-api.d.ts:570"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{33712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=t(24246),i=t(71670);const s={},o="Interface: RegisterKubernetesConnectionEvent",c={id:"interfaces/RegisterKubernetesConnectionEvent",title:"Interface: RegisterKubernetesConnectionEvent",description:"Properties",source:"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",sourceDirName:"interfaces",slug:"/interfaces/RegisterKubernetesConnectionEvent",permalink:"/api/interfaces/RegisterKubernetesConnectionEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegisterContainerConnectionEvent",permalink:"/api/interfaces/RegisterContainerConnectionEvent"},next:{title:"Registry",permalink:"/api/interfaces/Registry"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"providerId",id:"providerid",level:3},{value:"Source",id:"source",level:4}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-registerkubernetesconnectionevent",children:"Interface: RegisterKubernetesConnectionEvent"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"providerid",children:"providerId"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"providerId"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L570",children:"packages/extension-api/src/extension-api.d.ts:570"})})]})}function u(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>o});var r=t(27378);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e546fc5a.fc5d8cbf.js b/assets/js/e546fc5a.039a4645.js similarity index 87% rename from assets/js/e546fc5a.fc5d8cbf.js rename to assets/js/e546fc5a.039a4645.js index 0335772a1b8..10b926d6de0 100644 --- a/assets/js/e546fc5a.fc5d8cbf.js +++ b/assets/js/e546fc5a.039a4645.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{47037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",a={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"setProxy",permalink:"/api/namespaces/proxy/functions/setProxy"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L614",children:"packages/extension-api/src/extension-api.d.ts:614"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{47037:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Function: onDidUpdateProxy()",c={id:"namespaces/proxy/functions/onDidUpdateProxy",title:"Function: onDidUpdateProxy()",description:"onDidUpdateProxy(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidStateChange",permalink:"/api/namespaces/proxy/functions/onDidStateChange"},next:{title:"setProxy",permalink:"/api/namespaces/proxy/functions/setProxy"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdateproxy",children:"Function: onDidUpdateProxy()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateProxy"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L614",children:"packages/extension-api/src/extension-api.d.ts:614"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var i=s(27378);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6412603.b0713076.js b/assets/js/e6412603.51f44706.js similarity index 86% rename from assets/js/e6412603.b0713076.js rename to assets/js/e6412603.51f44706.js index cf09ecff397..49dfcb21b92 100644 --- a/assets/js/e6412603.b0713076.js +++ b/assets/js/e6412603.51f44706.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{3631:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=n(24246),t=n(71670);const r={},c="Function: onDidUpdateRegistry()",a={id:"namespaces/registry/functions/onDidUpdateRegistry",title:"Function: onDidUpdateRegistry()",description:"onDidUpdateRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUpdateRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"},next:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"}},o={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L669",children:"packages/extension-api/src/extension-api.d.ts:669"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>c});var i=n(27378);const t={},r=i.createContext(t);function c(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{3631:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=n(24246),t=n(71670);const r={},c="Function: onDidUpdateRegistry()",o={id:"namespaces/registry/functions/onDidUpdateRegistry",title:"Function: onDidUpdateRegistry()",description:"onDidUpdateRegistry(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/registry/functions/onDidUpdateRegistry.md",sourceDirName:"namespaces/registry/functions",slug:"/namespaces/registry/functions/onDidUpdateRegistry",permalink:"/api/namespaces/registry/functions/onDidUpdateRegistry",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUnregisterRegistry",permalink:"/api/namespaces/registry/functions/onDidUnregisterRegistry"},next:{title:"registerRegistry",permalink:"/api/namespaces/registry/functions/registerRegistry"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h1,{id:"function-ondidupdateregistry",children:"Function: onDidUpdateRegistry()"}),"\n",(0,i.jsxs)(s.blockquote,{children:["\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.strong,{children:"onDidUpdateRegistry"}),"(",(0,i.jsx)(s.code,{children:"listener"}),", ",(0,i.jsx)(s.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(s.code,{children:"disposables"}),"?): ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"listener"})]}),"\n",(0,i.jsx)(s.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(s.code,{children:"any"})]}),"\n",(0,i.jsxs)(s.p,{children:["The ",(0,i.jsx)(s.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(s.p,{children:["\u2022 ",(0,i.jsx)(s.strong,{children:"disposables?"}),": ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(s.p,{children:["An array to which a ",(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(s.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(s.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(s.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(s.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L669",children:"packages/extension-api/src/extension-api.d.ts:669"})})]})}function p(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>c});var i=n(27378);const t={},r=i.createContext(t);function c(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e69dadab.478f380e.js b/assets/js/e69dadab.7e1ce040.js similarity index 90% rename from assets/js/e69dadab.478f380e.js rename to assets/js/e69dadab.7e1ce040.js index cd707574789..7c5ab7c5604 100644 --- a/assets/js/e69dadab.478f380e.js +++ b/assets/js/e69dadab.7e1ce040.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{56168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),o=s(71670);const c={},r="Interface: PodmanContainerCreateOptions",t={id:"interfaces/PodmanContainerCreateOptions",title:"Interface: PodmanContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/PodmanContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodInfo",permalink:"/api/interfaces/PodInfo"},next:{title:"Port",permalink:"/api/interfaces/Port"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Source",id:"source-3",level:4},{value:"image?",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Source",id:"source-5",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2578",children:"packages/extension-api/src/extension-api.d.ts:2578"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2579",children:"packages/extension-api/src/extension-api.d.ts:2579"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2580",children:"packages/extension-api/src/extension-api.d.ts:2580"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2582",children:"packages/extension-api/src/extension-api.d.ts:2582"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2583",children:"packages/extension-api/src/extension-api.d.ts:2583"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2584",children:"packages/extension-api/src/extension-api.d.ts:2584"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2581",children:"packages/extension-api/src/extension-api.d.ts:2581"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{56168:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>a});var i=s(24246),o=s(71670);const c={},r="Interface: PodmanContainerCreateOptions",t={id:"interfaces/PodmanContainerCreateOptions",title:"Interface: PodmanContainerCreateOptions",description:"Properties",source:"@site/api/interfaces/PodmanContainerCreateOptions.md",sourceDirName:"interfaces",slug:"/interfaces/PodmanContainerCreateOptions",permalink:"/api/interfaces/PodmanContainerCreateOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PodInfo",permalink:"/api/interfaces/PodInfo"},next:{title:"Port",permalink:"/api/interfaces/Port"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"command?",id:"command",level:3},{value:"Source",id:"source",level:4},{value:"entrypoint?",id:"entrypoint",level:3},{value:"Source",id:"source-1",level:4},{value:"env?",id:"env",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-2",level:4},{value:"hostname?",id:"hostname",level:3},{value:"Source",id:"source-3",level:4},{value:"image?",id:"image",level:3},{value:"Source",id:"source-4",level:4},{value:"mounts?",id:"mounts",level:3},{value:"Source",id:"source-5",level:4},{value:"name?",id:"name",level:3},{value:"Source",id:"source-6",level:4},{value:"pod?",id:"pod",level:3},{value:"Source",id:"source-7",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"command",children:"command?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"command"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2578",children:"packages/extension-api/src/extension-api.d.ts:2578"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"entrypoint"}),": ",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2579",children:"packages/extension-api/src/extension-api.d.ts:2579"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"env",children:"env?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"env"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"key"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2580",children:"packages/extension-api/src/extension-api.d.ts:2580"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"hostname"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2582",children:"packages/extension-api/src/extension-api.d.ts:2582"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"image",children:"image?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"image"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2583",children:"packages/extension-api/src/extension-api.d.ts:2583"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"mounts"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2585",children:"packages/extension-api/src/extension-api.d.ts:2585"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2584",children:"packages/extension-api/src/extension-api.d.ts:2584"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pod",children:"pod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"pod"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2581",children:"packages/extension-api/src/extension-api.d.ts:2581"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>t,a:()=>r});var i=s(27378);const o={},c=i.createContext(o);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6c31e60.e342f6e4.js b/assets/js/e6c31e60.0e48bf3a.js similarity index 84% rename from assets/js/e6c31e60.e342f6e4.js rename to assets/js/e6c31e60.0e48bf3a.js index 8252fa40129..ea4bc8758f1 100644 --- a/assets/js/e6c31e60.e342f6e4.js +++ b/assets/js/e6c31e60.0e48bf3a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{32589:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var s=r(24246),i=r(71670);const t={},c="Interface: ProviderUpdate",d={id:"interfaces/ProviderUpdate",title:"Interface: ProviderUpdate",description:"Properties",source:"@site/api/interfaces/ProviderUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderOptions",permalink:"/api/interfaces/ProviderOptions"},next:{title:"ProxySettings",permalink:"/api/interfaces/ProxySettings"}},o={},a=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L420",children:"packages/extension-api/src/extension-api.d.ts:420"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"update"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L422",children:"packages/extension-api/src/extension-api.d.ts:422"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>d,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{32589:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});var s=r(24246),i=r(71670);const t={},c="Interface: ProviderUpdate",o={id:"interfaces/ProviderUpdate",title:"Interface: ProviderUpdate",description:"Properties",source:"@site/api/interfaces/ProviderUpdate.md",sourceDirName:"interfaces",slug:"/interfaces/ProviderUpdate",permalink:"/api/interfaces/ProviderUpdate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ProviderOptions",permalink:"/api/interfaces/ProviderOptions"},next:{title:"ProxySettings",permalink:"/api/interfaces/ProxySettings"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"version",id:"version",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"preflightChecks()?",id:"preflightchecks",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-providerupdate",children:"Interface: ProviderUpdate"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"version",children:"version"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"version"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L420",children:"packages/extension-api/src/extension-api.d.ts:420"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"preflightchecks",children:"preflightChecks()?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"preflightChecks"}),"(): ",(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/api/interfaces/InstallCheck",children:(0,s.jsx)(n.code,{children:"InstallCheck"})}),"[]"]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"update",children:"update()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"update"}),"(",(0,s.jsx)(n.code,{children:"logger"}),"): ",(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"logger"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,s.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L422",children:"packages/extension-api/src/extension-api.d.ts:422"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>o,a:()=>c});var s=r(27378);const i={},t=s.createContext(i);function c(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7477a94.5b3803e1.js b/assets/js/e7477a94.f2a6c910.js similarity index 94% rename from assets/js/e7477a94.5b3803e1.js rename to assets/js/e7477a94.f2a6c910.js index dd8b5c528ce..b90d5f30712 100644 --- a/assets/js/e7477a94.5b3803e1.js +++ b/assets/js/e7477a94.f2a6c910.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{46617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Interface: InstallCheck",o={id:"interfaces/InstallCheck",title:"Interface: InstallCheck",description:"Properties",source:"@site/api/interfaces/InstallCheck.md",sourceDirName:"interfaces",slug:"/interfaces/InstallCheck",permalink:"/api/interfaces/InstallCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"},next:{title:"KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"title",id:"title",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-installcheck",children:"Interface: InstallCheck"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L409",children:"packages/extension-api/src/extension-api.d.ts:409"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"init",children:"init()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"init"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L410",children:"packages/extension-api/src/extension-api.d.ts:410"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{46617:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const c={},r="Interface: InstallCheck",o={id:"interfaces/InstallCheck",title:"Interface: InstallCheck",description:"Properties",source:"@site/api/interfaces/InstallCheck.md",sourceDirName:"interfaces",slug:"/interfaces/InstallCheck",permalink:"/api/interfaces/InstallCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"InputBoxValidationMessage",permalink:"/api/interfaces/InputBoxValidationMessage"},next:{title:"KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"}},l={},d=[{value:"Properties",id:"properties",level:2},{value:"title",id:"title",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"execute()",id:"execute",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4},{value:"init()?",id:"init",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Source",id:"source-2",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-installcheck",children:"Interface: InstallCheck"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"title",children:"title"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})}),"\n",(0,t.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(n.h3,{id:"execute",children:"execute()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"execute"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"})," <",(0,t.jsx)(n.a,{href:"/api/interfaces/CheckResult",children:(0,t.jsx)(n.code,{children:"CheckResult"})}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L409",children:"packages/extension-api/src/extension-api.d.ts:409"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"init",children:"init()?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"init"}),"(): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L410",children:"packages/extension-api/src/extension-api.d.ts:410"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(27378);const i={},c=t.createContext(i);function r(e){const n=t.useContext(c);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7923b27.200dc5b1.js b/assets/js/e7923b27.b0caf232.js similarity index 96% rename from assets/js/e7923b27.200dc5b1.js rename to assets/js/e7923b27.b0caf232.js index f50652e21f6..303c7bce023 100644 --- a/assets/js/e7923b27.200dc5b1.js +++ b/assets/js/e7923b27.b0caf232.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{87335:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var t=s(24246),r=s(71670);const i={},c="Interface: Event()",a={id:"interfaces/Event",title:"Interface: Event()\\",description:"Event to subscribe",source:"@site/api/interfaces/Event.md",sourceDirName:"interfaces",slug:"/interfaces/Event",permalink:"/api/interfaces/Event",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"},next:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},l={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L125",children:"packages/extension-api/src/extension-api.d.ts:125"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{87335:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>o});var t=s(24246),r=s(71670);const i={},c="Interface: Event()",a={id:"interfaces/Event",title:"Interface: Event()\\",description:"Event to subscribe",source:"@site/api/interfaces/Event.md",sourceDirName:"interfaces",slug:"/interfaces/Event",permalink:"/api/interfaces/Event",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EndpointSettings",permalink:"/api/interfaces/EndpointSettings"},next:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},l={},o=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-eventt",children:"Interface: Event()"}),"\n",(0,t.jsx)(n.p,{children:"Event to subscribe"}),"\n",(0,t.jsx)(n.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Event"}),"(",(0,t.jsx)(n.code,{children:"listener"}),", ",(0,t.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,t.jsx)(n.code,{children:"disposables"}),"?): ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"listener"})]}),"\n",(0,t.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,t.jsx)(n.code,{children:"any"})]}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"disposables?"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,t.jsxs)(n.p,{children:["An array to which a ",(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L125",children:"packages/extension-api/src/extension-api.d.ts:125"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>a,a:()=>c});var t=s(27378);const r={},i=t.createContext(r);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e84cabb0.844e6b59.js b/assets/js/e84cabb0.044878ac.js similarity index 97% rename from assets/js/e84cabb0.844e6b59.js rename to assets/js/e84cabb0.044878ac.js index e238789579f..081fd0a5ddd 100644 --- a/assets/js/e84cabb0.844e6b59.js +++ b/assets/js/e84cabb0.044878ac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{59040:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const o={},c="Function: setProxy()",i={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setProxy"}),"(",(0,t.jsx)(n.code,{children:"proxySettings"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"proxySettings"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,t.jsx)(n.code,{children:"ProxySettings"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{59040:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>x,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var t=s(24246),r=s(71670);const o={},c="Function: setProxy()",i={id:"namespaces/proxy/functions/setProxy",title:"Function: setProxy()",description:"setProxy(proxySettings): Promise\\",source:"@site/api/namespaces/proxy/functions/setProxy.md",sourceDirName:"namespaces/proxy/functions",slug:"/namespaces/proxy/functions/setProxy",permalink:"/api/namespaces/proxy/functions/setProxy",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"onDidUpdateProxy",permalink:"/api/namespaces/proxy/functions/onDidUpdateProxy"},next:{title:"Namespace: registry",permalink:"/api/namespaces/registry/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-setproxy",children:"Function: setProxy()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"setProxy"}),"(",(0,t.jsx)(n.code,{children:"proxySettings"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"proxySettings"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ProxySettings",children:(0,t.jsx)(n.code,{children:"ProxySettings"})})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L612",children:"packages/extension-api/src/extension-api.d.ts:612"})})]})}function x(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>i,a:()=>c});var t=s(27378);const r={},o=t.createContext(r);function c(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e88443f3.175e63b9.js b/assets/js/e88443f3.7df11f85.js similarity index 95% rename from assets/js/e88443f3.175e63b9.js rename to assets/js/e88443f3.7df11f85.js index f416b0c1903..e6f8ec42cd5 100644 --- a/assets/js/e88443f3.175e63b9.js +++ b/assets/js/e88443f3.7df11f85.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{70678:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: stopPod()",r={id:"namespaces/containerEngine/functions/stopPod",title:"Function: stopPod()",description:"stopPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-stoppod",children:"Function: stopPod()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"stopPod"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"podId"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"podId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{70678:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const i={},c="Function: stopPod()",r={id:"namespaces/containerEngine/functions/stopPod",title:"Function: stopPod()",description:"stopPod(engineId, podId): Promise\\",source:"@site/api/namespaces/containerEngine/functions/stopPod.md",sourceDirName:"namespaces/containerEngine/functions",slug:"/namespaces/containerEngine/functions/stopPod",permalink:"/api/namespaces/containerEngine/functions/stopPod",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"stopContainer",permalink:"/api/namespaces/containerEngine/functions/stopContainer"},next:{title:"tagImage",permalink:"/api/namespaces/containerEngine/functions/tagImage"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,o.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"function-stoppod",children:"Function: stopPod()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"stopPod"}),"(",(0,t.jsx)(n.code,{children:"engineId"}),", ",(0,t.jsx)(n.code,{children:"podId"}),"): ",(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"engineId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"podId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3421",children:"packages/extension-api/src/extension-api.d.ts:3421"})})]})}function l(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var t=s(27378);const o={},i=t.createContext(o);function c(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e983a6d7.014856ed.js b/assets/js/e983a6d7.ba69138c.js similarity index 84% rename from assets/js/e983a6d7.014856ed.js rename to assets/js/e983a6d7.ba69138c.js index ea05a9ed53f..5d9424c9c19 100644 --- a/assets/js/e983a6d7.014856ed.js +++ b/assets/js/e983a6d7.ba69138c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{3532:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var a=s(24246),t=s(71670);const i={},c="Variable: isMac",r={id:"namespaces/env/variables/isMac",title:"Variable: isMac",description:"const isMac: boolean",source:"@site/api/namespaces/env/variables/isMac.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isMac",permalink:"/api/namespaces/env/variables/isMac",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"},next:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"}},o={},l=[{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"const"})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3707",children:"packages/extension-api/src/extension-api.d.ts:3707"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const t={},i=a.createContext(t);function c(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{3532:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>l});var a=s(24246),t=s(71670);const i={},c="Variable: isMac",r={id:"namespaces/env/variables/isMac",title:"Variable: isMac",description:"const isMac: boolean",source:"@site/api/namespaces/env/variables/isMac.md",sourceDirName:"namespaces/env/variables",slug:"/namespaces/env/variables/isMac",permalink:"/api/namespaces/env/variables/isMac",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"isLinux",permalink:"/api/namespaces/env/variables/isLinux"},next:{title:"isTelemetryEnabled",permalink:"/api/namespaces/env/variables/isTelemetryEnabled"}},o={},l=[{value:"Source",id:"source",level:2}];function p(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"variable-ismac",children:"Variable: isMac"}),"\n",(0,a.jsxs)(n.blockquote,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"const"})," ",(0,a.jsx)(n.strong,{children:"isMac"}),": ",(0,a.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Flag indicating whether we are running on macOS (Mac OS X) operating system."}),"\n",(0,a.jsx)(n.p,{children:"If the value of this flag is true, it means the current system is macOS.\nIf the value is false, it means the current system is not macOS."}),"\n",(0,a.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3707",children:"packages/extension-api/src/extension-api.d.ts:3707"})})]})}function d(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>c});var a=s(27378);const t={},i=a.createContext(t);function c(e){const n=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),a.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ea3ffc82.395ec18f.js b/assets/js/ea3ffc82.81c1c214.js similarity index 84% rename from assets/js/ea3ffc82.395ec18f.js rename to assets/js/ea3ffc82.81c1c214.js index 79cc4adf90a..9a0b1cfbde8 100644 --- a/assets/js/ea3ffc82.395ec18f.js +++ b/assets/js/ea3ffc82.81c1c214.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const r={},o="Interface: ExtensionContext",c={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Event",permalink:"/api/interfaces/Event"},next:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source",level:4},{value:"secrets",id:"secrets",level:3},{value:"Source",id:"source-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Source",id:"source-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"extensionUri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The uri of the directory containing the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L165",children:"packages/extension-api/src/extension-api.d.ts:165"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"secrets"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,t.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L170",children:"packages/extension-api/src/extension-api.d.ts:170"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"storagePath"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An absolute file path in which the extension can store state.\nThe directory might not exist on disk and creation is\nup to the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L160",children:"packages/extension-api/src/extension-api.d.ts:160"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"subscriptions"}),": ",(0,t.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L153",children:"packages/extension-api/src/extension-api.d.ts:153"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>o});var t=s(27378);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65268:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const r={},c="Interface: ExtensionContext",o={id:"interfaces/ExtensionContext",title:"Interface: ExtensionContext",description:"Properties",source:"@site/api/interfaces/ExtensionContext.md",sourceDirName:"interfaces",slug:"/interfaces/ExtensionContext",permalink:"/api/interfaces/ExtensionContext",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Event",permalink:"/api/interfaces/Event"},next:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source",level:4},{value:"secrets",id:"secrets",level:3},{value:"Source",id:"source-1",level:4},{value:"storagePath",id:"storagepath",level:3},{value:"Source",id:"source-2",level:4},{value:"subscriptions",id:"subscriptions",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-extensioncontext",children:"Interface: ExtensionContext"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"extensionUri"}),": ",(0,t.jsx)(n.a,{href:"/api/classes/Uri",children:(0,t.jsx)(n.code,{children:"Uri"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The uri of the directory containing the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L165",children:"packages/extension-api/src/extension-api.d.ts:165"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"secrets",children:"secrets"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"secrets"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/SecretStorage",children:(0,t.jsx)(n.code,{children:"SecretStorage"})})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"A storage utility for secrets. Secrets are persisted across reloads."}),"\n",(0,t.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L170",children:"packages/extension-api/src/extension-api.d.ts:170"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"storagepath",children:"storagePath"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"storagePath"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"An absolute file path in which the extension can store state.\nThe directory might not exist on disk and creation is\nup to the extension."}),"\n",(0,t.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L160",children:"packages/extension-api/src/extension-api.d.ts:160"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"subscriptions",children:"subscriptions"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"readonly"})," ",(0,t.jsx)(n.strong,{children:"subscriptions"}),": ",(0,t.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L153",children:"packages/extension-api/src/extension-api.d.ts:153"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var t=s(27378);const i={},r=t.createContext(i);function c(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed2a4846.7ea08a7b.js b/assets/js/ed2a4846.c041e84d.js similarity index 76% rename from assets/js/ed2a4846.7ea08a7b.js rename to assets/js/ed2a4846.c041e84d.js index 750c76837f3..f1099c4c9f0 100644 --- a/assets/js/ed2a4846.7ea08a7b.js +++ b/assets/js/ed2a4846.c041e84d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{1427:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=n(24246),s=n(71670);const i={},a="Interface: GenerateKubeResult",c={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"}),"\n",(0,r.jsx)(t.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"yaml"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1875",children:"packages/extension-api/src/extension-api.d.ts:1875"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>a});var r=n(27378);const s={},i=r.createContext(s);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{1427:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=n(24246),s=n(71670);const i={},c="Interface: GenerateKubeResult",a={id:"interfaces/GenerateKubeResult",title:"Interface: GenerateKubeResult",description:"The result containing a Kubernetes config files",source:"@site/api/interfaces/GenerateKubeResult.md",sourceDirName:"interfaces",slug:"/interfaces/GenerateKubeResult",permalink:"/api/interfaces/GenerateKubeResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"FileSystemWatcher",permalink:"/api/interfaces/FileSystemWatcher"},next:{title:"HealthCheckLog",permalink:"/api/interfaces/HealthCheckLog"}},o={},l=[{value:"Properties",id:"properties",level:2},{value:"yaml",id:"yaml",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-generatekuberesult",children:"Interface: GenerateKubeResult"}),"\n",(0,r.jsx)(t.p,{children:"The result containing a Kubernetes config files"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"yaml",children:"yaml"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"yaml"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1875",children:"packages/extension-api/src/extension-api.d.ts:1875"})})]})}function d(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>c});var r=n(27378);const s={},i=r.createContext(s);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ed603d23.07fe4c85.js b/assets/js/ed603d23.989866ed.js similarity index 85% rename from assets/js/ed603d23.07fe4c85.js rename to assets/js/ed603d23.989866ed.js index a1b7237571d..9af8a14499c 100644 --- a/assets/js/ed603d23.07fe4c85.js +++ b/assets/js/ed603d23.989866ed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{65669:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Interface: KubernetesGeneratorProvider",a={id:"interfaces/KubernetesGeneratorProvider",title:"Interface: KubernetesGeneratorProvider",description:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific",source:"@site/api/interfaces/KubernetesGeneratorProvider.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"},next:{title:"KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"}},c={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"types",id:"types",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"generate()",id:"generate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"}),"\n",(0,t.jsx)(r.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1890",children:"packages/extension-api/src/extension-api.d.ts:1890"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"types"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1891",children:"packages/extension-api/src/extension-api.d.ts:1891"})}),"\n",(0,t.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(r.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"generate"}),"(",(0,t.jsx)(r.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(r.code,{children:"Promise"})," <",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\n",(0,t.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"Promise"})," <",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})}),">"]}),"\n",(0,t.jsx)(r.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1892",children:"packages/extension-api/src/extension-api.d.ts:1892"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>a,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{65669:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Interface: KubernetesGeneratorProvider",c={id:"interfaces/KubernetesGeneratorProvider",title:"Interface: KubernetesGeneratorProvider",description:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific",source:"@site/api/interfaces/KubernetesGeneratorProvider.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubeconfigUpdateEvent",permalink:"/api/interfaces/KubeconfigUpdateEvent"},next:{title:"KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"types",id:"types",level:3},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"generate()",id:"generate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"interface-kubernetesgeneratorprovider",children:"Interface: KubernetesGeneratorProvider"}),"\n",(0,t.jsx)(r.p,{children:"The KubernetesGeneratorProvider allows an extension to register a custom Kube Generator for a specific\nKubernetesGeneratorType."}),"\n",(0,t.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"name"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1890",children:"packages/extension-api/src/extension-api.d.ts:1890"})}),"\n",(0,t.jsx)(r.hr,{}),"\n",(0,t.jsx)(r.h3,{id:"types",children:"types"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"types"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorSelector",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorSelector"})})]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1891",children:"packages/extension-api/src/extension-api.d.ts:1891"})}),"\n",(0,t.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,t.jsx)(r.h3,{id:"generate",children:"generate()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"generate"}),"(",(0,t.jsx)(r.code,{children:"kubernetesGeneratorArguments"}),"): ",(0,t.jsx)(r.code,{children:"Promise"})," <",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})}),">"]}),"\n"]}),"\n",(0,t.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"kubernetesGeneratorArguments"}),": ",(0,t.jsx)(r.a,{href:"/api/type-aliases/KubernetesGeneratorArgument",children:(0,t.jsx)(r.code,{children:"KubernetesGeneratorArgument"})}),"[]"]}),"\n",(0,t.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.code,{children:"Promise"})," <",(0,t.jsx)(r.a,{href:"/api/interfaces/GenerateKubeResult",children:(0,t.jsx)(r.code,{children:"GenerateKubeResult"})}),">"]}),"\n",(0,t.jsx)(r.h4,{id:"source-2",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1892",children:"packages/extension-api/src/extension-api.d.ts:1892"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edb40f78.9e907467.js b/assets/js/edb40f78.80e11e37.js similarity index 95% rename from assets/js/edb40f78.9e907467.js rename to assets/js/edb40f78.80e11e37.js index abee8dbbfb8..05d24e819cd 100644 --- a/assets/js/edb40f78.9e907467.js +++ b/assets/js/edb40f78.80e11e37.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{7453:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(24246),t=s(71670);const o={},i="Interface: Progress",a={id:"interfaces/Progress",title:"Interface: Progress\\",description:"Defines a generalized way of reporting progress updates.",source:"@site/api/interfaces/Progress.md",sourceDirName:"interfaces",slug:"/interfaces/Progress",permalink:"/api/interfaces/Progress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PortMap",permalink:"/api/interfaces/PortMap"},next:{title:"ProgressOptions",permalink:"/api/interfaces/ProgressOptions"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"report()",id:"report",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"}),"\n",(0,n.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,n.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"T"})]}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"report"}),"(",(0,n.jsx)(r.code,{children:"value"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"T"})]}),"\n",(0,n.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L765",children:"packages/extension-api/src/extension-api.d.ts:765"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>i});var n=s(27378);const t={},o=n.createContext(t);function i(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{7453:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(24246),t=s(71670);const o={},i="Interface: Progress",a={id:"interfaces/Progress",title:"Interface: Progress\\",description:"Defines a generalized way of reporting progress updates.",source:"@site/api/interfaces/Progress.md",sourceDirName:"interfaces",slug:"/interfaces/Progress",permalink:"/api/interfaces/Progress",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"PortMap",permalink:"/api/interfaces/PortMap"},next:{title:"ProgressOptions",permalink:"/api/interfaces/ProgressOptions"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Methods",id:"methods",level:2},{value:"report()",id:"report",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-progresst",children:"Interface: Progress"}),"\n",(0,n.jsx)(r.p,{children:"Defines a generalized way of reporting progress updates."}),"\n",(0,n.jsx)(r.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"T"})]}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"report",children:"report()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"report"}),"(",(0,n.jsx)(r.code,{children:"value"}),"): ",(0,n.jsx)(r.code,{children:"void"})]}),"\n"]}),"\n",(0,n.jsx)(r.p,{children:"Report a progress update."}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"value"}),": ",(0,n.jsx)(r.code,{children:"T"})]}),"\n",(0,n.jsx)(r.p,{children:"A progress item, like a message and/or an\nreport on how much work finished"}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"void"})}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L765",children:"packages/extension-api/src/extension-api.d.ts:765"})})]})}function l(e={}){const{wrapper:r}={...(0,t.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},71670:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>i});var n=s(27378);const t={},o=n.createContext(t);function i(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edcfca88.181ccbab.js b/assets/js/edcfca88.025efc4b.js similarity index 88% rename from assets/js/edcfca88.181ccbab.js rename to assets/js/edcfca88.025efc4b.js index 9b172233605..820048dd9dc 100644 --- a/assets/js/edcfca88.181ccbab.js +++ b/assets/js/edcfca88.025efc4b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41902],{57283:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const c={},r="Interface: ManifestInspectInfo",o={id:"interfaces/ManifestInspectInfo",title:"Interface: ManifestInspectInfo",description:"Properties",source:"@site/api/interfaces/ManifestInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"},next:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-1",level:4},{value:"manifests",id:"manifests",level:3},{value:"Source",id:"source-2",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Source",id:"source-3",level:4},{value:"schemaVersion",id:"schemaversion",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestinspectinfo",children:"Interface: ManifestInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L318",children:"packages/extension-api/src/extension-api.d.ts:318"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"manifests",children:"manifests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"manifests"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L319",children:"packages/extension-api/src/extension-api.d.ts:319"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mediatype",children:"mediaType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"mediaType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L331",children:"packages/extension-api/src/extension-api.d.ts:331"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"schemaversion",children:"schemaVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"schemaVersion"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L332",children:"packages/extension-api/src/extension-api.d.ts:332"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41902],{57283:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const c={},r="Interface: ManifestInspectInfo",o={id:"interfaces/ManifestInspectInfo",title:"Interface: ManifestInspectInfo",description:"Properties",source:"@site/api/interfaces/ManifestInspectInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ManifestInspectInfo",permalink:"/api/interfaces/ManifestInspectInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ManifestCreateOptions",permalink:"/api/interfaces/ManifestCreateOptions"},next:{title:"MemoryStats",permalink:"/api/interfaces/MemoryStats"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-1",level:4},{value:"manifests",id:"manifests",level:3},{value:"Source",id:"source-2",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Source",id:"source-3",level:4},{value:"schemaVersion",id:"schemaversion",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-manifestinspectinfo",children:"Interface: ManifestInspectInfo"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineId"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L317",children:"packages/extension-api/src/extension-api.d.ts:317"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"engineName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L318",children:"packages/extension-api/src/extension-api.d.ts:318"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"manifests",children:"manifests"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"manifests"}),": ",(0,i.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L319",children:"packages/extension-api/src/extension-api.d.ts:319"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mediatype",children:"mediaType"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"mediaType"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L331",children:"packages/extension-api/src/extension-api.d.ts:331"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"schemaversion",children:"schemaVersion"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"schemaVersion"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L332",children:"packages/extension-api/src/extension-api.d.ts:332"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const t={},c=i.createContext(t);function r(e){const n=i.useContext(c);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f1ad83b2.1510c5a7.js b/assets/js/f1ad83b2.cf54f055.js similarity index 92% rename from assets/js/f1ad83b2.1510c5a7.js rename to assets/js/f1ad83b2.cf54f055.js index ebc07b1e0f9..9940d66f875 100644 --- a/assets/js/f1ad83b2.1510c5a7.js +++ b/assets/js/f1ad83b2.cf54f055.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{19376:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=r(24246),t=r(71670);const s={},o="Interface: KubernetesProviderConnection",c={id:"interfaces/KubernetesProviderConnection",title:"Interface: KubernetesProviderConnection",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"},next:{title:"KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"endpoint"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L340",children:"packages/extension-api/src/extension-api.d.ts:340"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lifecycle"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,i.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L341",children:"packages/extension-api/src/extension-api.d.ts:341"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),"(): ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L342",children:"packages/extension-api/src/extension-api.d.ts:342"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(27378);const t={},s=i.createContext(t);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{19376:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var i=r(24246),t=r(71670);const s={},o="Interface: KubernetesProviderConnection",c={id:"interfaces/KubernetesProviderConnection",title:"Interface: KubernetesProviderConnection",description:"Properties",source:"@site/api/interfaces/KubernetesProviderConnection.md",sourceDirName:"interfaces",slug:"/interfaces/KubernetesProviderConnection",permalink:"/api/interfaces/KubernetesProviderConnection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"KubernetesGeneratorProvider",permalink:"/api/interfaces/KubernetesGeneratorProvider"},next:{title:"KubernetesProviderConnectionEndpoint",permalink:"/api/interfaces/KubernetesProviderConnectionEndpoint"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"endpoint",id:"endpoint",level:3},{value:"Source",id:"source",level:4},{value:"lifecycle?",id:"lifecycle",level:3},{value:"Source",id:"source-1",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-2",level:4},{value:"Methods",id:"methods",level:2},{value:"status()",id:"status",level:3},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-kubernetesproviderconnection",children:"Interface: KubernetesProviderConnection"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"endpoint"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/KubernetesProviderConnectionEndpoint",children:(0,i.jsx)(n.code,{children:"KubernetesProviderConnectionEndpoint"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L340",children:"packages/extension-api/src/extension-api.d.ts:340"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"lifecycle"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,i.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L341",children:"packages/extension-api/src/extension-api.d.ts:341"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})}),"\n",(0,i.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"status"}),"(): ",(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,i.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L342",children:"packages/extension-api/src/extension-api.d.ts:342"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>o});var i=r(27378);const t={},s=i.createContext(t);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f20efc55.75d9a05e.js b/assets/js/f20efc55.9778a34d.js similarity index 97% rename from assets/js/f20efc55.75d9a05e.js rename to assets/js/f20efc55.9778a34d.js index 0b48930385c..e11d4c3146a 100644 --- a/assets/js/f20efc55.75d9a05e.js +++ b/assets/js/f20efc55.9778a34d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{18646:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"version",permalink:"/api/variables/version"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.code,{children:"const"})," ",(0,a.jsx)(e.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(e.code,{children:"0"})," = ",(0,a.jsx)(e.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,r)=>{r.d(e,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(t){const e=a.useContext(n);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{18646:(t,e,r)=>{r.r(e),r.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>l});var a=r(24246),i=r(71670);const n={},s="Variable: StatusBarItemDefaultPriority",o={id:"variables/StatusBarItemDefaultPriority",title:"Variable: StatusBarItemDefaultPriority",description:"const StatusBarItemDefaultPriority: 0 = 0",source:"@site/api/variables/StatusBarItemDefaultPriority.md",sourceDirName:"variables",slug:"/variables/StatusBarItemDefaultPriority",permalink:"/api/variables/StatusBarItemDefaultPriority",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"StatusBarAlignRight",permalink:"/api/variables/StatusBarAlignRight"},next:{title:"version",permalink:"/api/variables/version"}},c={},l=[{value:"Source",id:"source",level:2}];function u(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...t.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(e.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\n",(0,a.jsxs)(e.blockquote,{children:["\n",(0,a.jsxs)(e.p,{children:[(0,a.jsx)(e.code,{children:"const"})," ",(0,a.jsx)(e.strong,{children:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(e.code,{children:"0"})," = ",(0,a.jsx)(e.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(e.p,{children:"Default priority for the status bar items."}),"\n",(0,a.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,a.jsx)(e.p,{children:(0,a.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})})]})}function d(t={}){const{wrapper:e}={...(0,i.a)(),...t.components};return e?(0,a.jsx)(e,{...t,children:(0,a.jsx)(u,{...t})}):u(t)}},71670:(t,e,r)=>{r.d(e,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(t){const e=a.useContext(n);return a.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function o(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:s(t.components),a.createElement(n.Provider,{value:e},t.children)}}}]); \ No newline at end of file diff --git a/assets/js/f27eaf88.1dc56cbc.js b/assets/js/f27eaf88.84b8f89d.js similarity index 93% rename from assets/js/f27eaf88.1dc56cbc.js rename to assets/js/f27eaf88.84b8f89d.js index 3e9c0ecd111..e3d1f82dbb6 100644 --- a/assets/js/f27eaf88.1dc56cbc.js +++ b/assets/js/f27eaf88.84b8f89d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{44677:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=t(24246),c=t(71670);const o={},i="Interface: CancellationToken",a={id:"interfaces/CancellationToken",title:"Interface: CancellationToken",description:"A cancellation token is passed to an asynchronous or long running",source:"@site/api/interfaces/CancellationToken.md",sourceDirName:"interfaces",slug:"/interfaces/CancellationToken",permalink:"/api/interfaces/CancellationToken",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CPUUsage",permalink:"/api/interfaces/CPUUsage"},next:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"isCancellationRequested",id:"iscancellationrequested",level:3},{value:"Source",id:"source",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"}),"\n",(0,s.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Is ",(0,s.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L820",children:"packages/extension-api/src/extension-api.d.ts:820"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L826",children:"packages/extension-api/src/extension-api.d.ts:826"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{44677:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var s=t(24246),c=t(71670);const o={},i="Interface: CancellationToken",a={id:"interfaces/CancellationToken",title:"Interface: CancellationToken",description:"A cancellation token is passed to an asynchronous or long running",source:"@site/api/interfaces/CancellationToken.md",sourceDirName:"interfaces",slug:"/interfaces/CancellationToken",permalink:"/api/interfaces/CancellationToken",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CPUUsage",permalink:"/api/interfaces/CPUUsage"},next:{title:"CheckResult",permalink:"/api/interfaces/CheckResult"}},r={},l=[{value:"Properties",id:"properties",level:2},{value:"isCancellationRequested",id:"iscancellationrequested",level:3},{value:"Source",id:"source",level:4},{value:"onCancellationRequested",id:"oncancellationrequested",level:3},{value:"Source",id:"source-1",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"}),"\n",(0,s.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Is ",(0,s.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,s.jsx)(n.code,{children:"false"})," otherwise."]}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L820",children:"packages/extension-api/src/extension-api.d.ts:820"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,s.jsx)(n.code,{children:"Event"})}),"<",(0,s.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["An ",(0,s.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L826",children:"packages/extension-api/src/extension-api.d.ts:826"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var s=t(27378);const c={},o=s.createContext(c);function i(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4271232.79af877b.js b/assets/js/f4271232.ce24c220.js similarity index 95% rename from assets/js/f4271232.79af877b.js rename to assets/js/f4271232.ce24c220.js index b2c37fea317..b47d2001b4b 100644 --- a/assets/js/f4271232.79af877b.js +++ b/assets/js/f4271232.ce24c220.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{64336:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=t(24246),i=t(71670);const a={},s="Function: navigateToContainerLogs()",r={id:"namespaces/navigation/functions/navigateToContainerLogs",title:"Function: navigateToContainerLogs()",description:"navigateToContainerLogs(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerLogs.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"},next:{title:"navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(0,o.jsx)(e.code,{children:"id"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"id"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4186",children:"packages/extension-api/src/extension-api.d.ts:4186"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var o=t(27378);const i={},a=o.createContext(i);function s(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{64336:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=t(24246),i=t(71670);const a={},s="Function: navigateToContainerLogs()",r={id:"namespaces/navigation/functions/navigateToContainerLogs",title:"Function: navigateToContainerLogs()",description:"navigateToContainerLogs(id): Promise\\",source:"@site/api/namespaces/navigation/functions/navigateToContainerLogs.md",sourceDirName:"namespaces/navigation/functions",slug:"/namespaces/navigation/functions/navigateToContainerLogs",permalink:"/api/namespaces/navigation/functions/navigateToContainerLogs",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"navigateToContainerInspect",permalink:"/api/namespaces/navigation/functions/navigateToContainerInspect"},next:{title:"navigateToContainerTerminal",permalink:"/api/namespaces/navigation/functions/navigateToContainerTerminal"}},c={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(n){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"function-navigatetocontainerlogs",children:"Function: navigateToContainerLogs()"}),"\n",(0,o.jsxs)(e.blockquote,{children:["\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"navigateToContainerLogs"}),"(",(0,o.jsx)(e.code,{children:"id"}),"): ",(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsxs)(e.p,{children:["\u2022 ",(0,o.jsx)(e.strong,{children:"id"}),": ",(0,o.jsx)(e.code,{children:"string"})]}),"\n",(0,o.jsx)(e.h2,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.code,{children:"Promise"}),"<",(0,o.jsx)(e.code,{children:"void"}),">"]}),"\n",(0,o.jsx)(e.h2,{id:"source",children:"Source"}),"\n",(0,o.jsx)(e.p,{children:(0,o.jsx)(e.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4186",children:"packages/extension-api/src/extension-api.d.ts:4186"})})]})}function u(n={}){const{wrapper:e}={...(0,i.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(l,{...n})}):l(n)}},71670:(n,e,t)=>{t.d(e,{Z:()=>r,a:()=>s});var o=t(27378);const i={},a=o.createContext(i);function s(n){const e=o.useContext(a);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cd0d3d.78e7e655.js b/assets/js/f6cd0d3d.9842885d.js similarity index 94% rename from assets/js/f6cd0d3d.78e7e655.js rename to assets/js/f6cd0d3d.9842885d.js index 76986474d42..e20f6e57027 100644 --- a/assets/js/f6cd0d3d.78e7e655.js +++ b/assets/js/f6cd0d3d.9842885d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{7072:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=t(24246),s=t(71670);const i={},c="Interface: RegistryProvider",o={id:"interfaces/RegistryProvider",title:"Interface: RegistryProvider",description:"Properties",source:"@site/api/interfaces/RegistryProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryProvider",permalink:"/api/interfaces/RegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions"},next:{title:"RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L649",children:"packages/extension-api/src/extension-api.d.ts:649"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"create"}),"(",(0,n.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,n.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})}),"\n",(0,n.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})})]})}function p(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>c});var n=t(27378);const s={},i=n.createContext(s);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{7072:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=t(24246),s=t(71670);const i={},c="Interface: RegistryProvider",o={id:"interfaces/RegistryProvider",title:"Interface: RegistryProvider",description:"Properties",source:"@site/api/interfaces/RegistryProvider.md",sourceDirName:"interfaces",slug:"/interfaces/RegistryProvider",permalink:"/api/interfaces/RegistryProvider",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"RegistryCreateOptions",permalink:"/api/interfaces/RegistryCreateOptions"},next:{title:"RegistrySuggestedProvider",permalink:"/api/interfaces/RegistrySuggestedProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"name",id:"name",level:3},{value:"Source",id:"source",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-1",level:4}];function l(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"interface-registryprovider",children:"Interface: RegistryProvider"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"name"}),": ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"source",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L649",children:"packages/extension-api/src/extension-api.d.ts:649"})}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"create"}),"(",(0,n.jsx)(r.code,{children:"registryCreateOptions"}),"): ",(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(r.p,{children:["\u2022 ",(0,n.jsx)(r.strong,{children:"registryCreateOptions"}),": ",(0,n.jsx)(r.a,{href:"/api/interfaces/RegistryCreateOptions",children:(0,n.jsx)(r.code,{children:"RegistryCreateOptions"})})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/api/interfaces/Registry",children:(0,n.jsx)(r.code,{children:"Registry"})})}),"\n",(0,n.jsx)(r.h4,{id:"source-1",children:"Source"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})})]})}function p(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},71670:(e,r,t)=>{t.d(r,{Z:()=>o,a:()=>c});var n=t(27378);const s={},i=n.createContext(s);function c(e){const r=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6cf66bc.dd896984.js b/assets/js/f6cf66bc.a6dab972.js similarity index 98% rename from assets/js/f6cf66bc.dd896984.js rename to assets/js/f6cf66bc.a6dab972.js index 934349cbc8d..5eee53f3b01 100644 --- a/assets/js/f6cf66bc.dd896984.js +++ b/assets/js/f6cf66bc.a6dab972.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{74577:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1841",children:"packages/extension-api/src/extension-api.d.ts:1841"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{74577:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const r={},c="Function: onDidUpdateKubeconfig()",o={id:"namespaces/kubernetes/functions/onDidUpdateKubeconfig",title:"Function: onDidUpdateKubeconfig()",description:"onDidUpdateKubeconfig(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",sourceDirName:"namespaces/kubernetes/functions",slug:"/namespaces/kubernetes/functions/onDidUpdateKubeconfig",permalink:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getKubeconfig",permalink:"/api/namespaces/kubernetes/functions/getKubeconfig"},next:{title:"registerKubernetesGenerator",permalink:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidupdatekubeconfig",children:"Function: onDidUpdateKubeconfig()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidUpdateKubeconfig"}),"(",(0,i.jsx)(n.code,{children:"listener"}),", ",(0,i.jsx)(n.code,{children:"thisArgs"}),"?, ",(0,i.jsx)(n.code,{children:"disposables"}),"?): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"listener"})]}),"\n",(0,i.jsx)(n.p,{children:"The listener function will be called when the event happens."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"thisArgs?"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"this"}),"-argument which will be used when calling the event listener."]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"disposables?"}),": ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["An array to which a ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:"Disposable"})," will be added."]}),"\n",(0,i.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})}),"\n",(0,i.jsx)(n.p,{children:"A disposable which unsubscribes the event listener."}),"\n",(0,i.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1841",children:"packages/extension-api/src/extension-api.d.ts:1841"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>c});var i=s(27378);const t={},r=i.createContext(t);function c(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7197f43.7613f36a.js b/assets/js/f7197f43.104ca7ac.js similarity index 97% rename from assets/js/f7197f43.7613f36a.js rename to assets/js/f7197f43.104ca7ac.js index 3aa1e20d4fb..b305a952d38 100644 --- a/assets/js/f7197f43.7613f36a.js +++ b/assets/js/f7197f43.104ca7ac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{59308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var t=r(24246),n=r(71670);const l={},a="Class: TelemetryTrustedValue",i={id:"classes/TelemetryTrustedValue",title:"Class: TelemetryTrustedValue\\",description:"A special value wrapper denoting a value that is safe to not clean.",source:"@site/api/classes/TelemetryTrustedValue.md",sourceDirName:"classes",slug:"/classes/TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EventEmitter",permalink:"/api/classes/EventEmitter"},next:{title:"Uri",permalink:"/api/classes/Uri"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new TelemetryTrustedValue()",id:"new-telemetrytrustedvalue",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Source",id:"source-1",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"}),"\n",(0,t.jsx)(s.p,{children:"A special value wrapper denoting a value that is safe to not clean.\nThis is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})," = ",(0,t.jsx)(s.code,{children:"any"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-telemetrytrustedvalue",children:"new TelemetryTrustedValue()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(",(0,t.jsx)(s.code,{children:"value"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3879",children:"packages/extension-api/src/extension-api.d.ts:3879"})}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"readonly"})," ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3877",children:"packages/extension-api/src/extension-api.d.ts:3877"})})]})}function u(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>i,a:()=>a});var t=r(27378);const n={},l=t.createContext(n);function a(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{59308:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var t=r(24246),n=r(71670);const l={},a="Class: TelemetryTrustedValue",i={id:"classes/TelemetryTrustedValue",title:"Class: TelemetryTrustedValue\\",description:"A special value wrapper denoting a value that is safe to not clean.",source:"@site/api/classes/TelemetryTrustedValue.md",sourceDirName:"classes",slug:"/classes/TelemetryTrustedValue",permalink:"/api/classes/TelemetryTrustedValue",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"EventEmitter",permalink:"/api/classes/EventEmitter"},next:{title:"Uri",permalink:"/api/classes/Uri"}},c={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Constructors",id:"constructors",level:2},{value:"new TelemetryTrustedValue()",id:"new-telemetrytrustedvalue",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source",level:4},{value:"Properties",id:"properties",level:2},{value:"value",id:"value",level:3},{value:"Source",id:"source-1",level:4}];function o(e){const s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h1,{id:"class-telemetrytrustedvaluet",children:"Class: TelemetryTrustedValue"}),"\n",(0,t.jsx)(s.p,{children:"A special value wrapper denoting a value that is safe to not clean.\nThis is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it."}),"\n",(0,t.jsx)(s.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"T"})," = ",(0,t.jsx)(s.code,{children:"any"})]}),"\n",(0,t.jsx)(s.h2,{id:"constructors",children:"Constructors"}),"\n",(0,t.jsx)(s.h3,{id:"new-telemetrytrustedvalue",children:"new TelemetryTrustedValue()"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"new TelemetryTrustedValue"}),"<",(0,t.jsx)(s.code,{children:"T"}),">(",(0,t.jsx)(s.code,{children:"value"}),"): ",(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(s.p,{children:["\u2022 ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n",(0,t.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.a,{href:"/api/classes/TelemetryTrustedValue",children:(0,t.jsx)(s.code,{children:"TelemetryTrustedValue"})}),"<",(0,t.jsx)(s.code,{children:"T"}),">"]}),"\n",(0,t.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3879",children:"packages/extension-api/src/extension-api.d.ts:3879"})}),"\n",(0,t.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(s.h3,{id:"value",children:"value"}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.code,{children:"readonly"})," ",(0,t.jsx)(s.strong,{children:"value"}),": ",(0,t.jsx)(s.code,{children:"T"})]}),"\n"]}),"\n",(0,t.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3877",children:"packages/extension-api/src/extension-api.d.ts:3877"})})]})}function u(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},71670:(e,s,r)=>{r.d(s,{Z:()=>i,a:()=>a});var t=r(27378);const n={},l=t.createContext(n);function a(e){const s=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function i(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(l.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f771dec1.8aefadb5.js b/assets/js/f771dec1.aaa1bd00.js similarity index 95% rename from assets/js/f771dec1.8aefadb5.js rename to assets/js/f771dec1.aaa1bd00.js index 74bba7c1f90..be2e449b8e3 100644 --- a/assets/js/f771dec1.8aefadb5.js +++ b/assets/js/f771dec1.aaa1bd00.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{29150:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=o(24246),t=o(71670);const i={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"},next:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCliTool"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Register new CLI Tool"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolOptions",children:(0,s.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,s.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4104",children:"packages/extension-api/src/extension-api.d.ts:4104"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>c});var s=o(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{29150:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>a});var s=o(24246),t=o(71670);const i={},c="Function: createCliTool()",r={id:"namespaces/cli/functions/createCliTool",title:"Function: createCliTool()",description:"createCliTool(options): CliTool",source:"@site/api/namespaces/cli/functions/createCliTool.md",sourceDirName:"namespaces/cli/functions",slug:"/namespaces/cli/functions/createCliTool",permalink:"/api/namespaces/cli/functions/createCliTool",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: cli",permalink:"/api/namespaces/cli/"},next:{title:"Namespace: commands",permalink:"/api/namespaces/commands/"}},l={},a=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"createCliTool"}),"(",(0,s.jsx)(n.code,{children:"options"}),"): ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Register new CLI Tool"}),"\n",(0,s.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"options"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/CliToolOptions",children:(0,s.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,s.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,s.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,s.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,s.jsx)(n.p,{children:"CliTool instance"}),"\n",(0,s.jsx)(n.h2,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4104",children:"packages/extension-api/src/extension-api.d.ts:4104"})})]})}function p(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>c});var s=o(27378);const t={},i=s.createContext(t);function c(e){const n=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7c9e078.52348da3.js b/assets/js/f7c9e078.8efd229e.js similarity index 89% rename from assets/js/f7c9e078.52348da3.js rename to assets/js/f7c9e078.8efd229e.js index ca5e78dba2b..aed85a346b6 100644 --- a/assets/js/f7c9e078.52348da3.js +++ b/assets/js/f7c9e078.8efd229e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{9196:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(24246),i=n(71670);const s={},o="Interface: ThrottlingData",c={id:"interfaces/ThrottlingData",title:"Interface: ThrottlingData",description:"Properties",source:"@site/api/interfaces/ThrottlingData.md",sourceDirName:"interfaces",slug:"/interfaces/ThrottlingData",permalink:"/api/interfaces/ThrottlingData",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetrySender",permalink:"/api/interfaces/TelemetrySender"},next:{title:"UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Source",id:"source",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Source",id:"source-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"periods",children:"periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2894",children:"packages/extension-api/src/extension-api.d.ts:2894"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2895",children:"packages/extension-api/src/extension-api.d.ts:2895"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_time"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})})]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>o});var r=n(27378);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{9196:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var r=n(24246),i=n(71670);const s={},o="Interface: ThrottlingData",c={id:"interfaces/ThrottlingData",title:"Interface: ThrottlingData",description:"Properties",source:"@site/api/interfaces/ThrottlingData.md",sourceDirName:"interfaces",slug:"/interfaces/ThrottlingData",permalink:"/api/interfaces/ThrottlingData",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"TelemetrySender",permalink:"/api/interfaces/TelemetrySender"},next:{title:"UnregisterContainerConnectionEvent",permalink:"/api/interfaces/UnregisterContainerConnectionEvent"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"periods",id:"periods",level:3},{value:"Source",id:"source",level:4},{value:"throttled_periods",id:"throttled_periods",level:3},{value:"Source",id:"source-1",level:4},{value:"throttled_time",id:"throttled_time",level:3},{value:"Source",id:"source-2",level:4}];function l(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-throttlingdata",children:"Interface: ThrottlingData"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"periods",children:"periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2894",children:"packages/extension-api/src/extension-api.d.ts:2894"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_periods",children:"throttled_periods"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_periods"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2895",children:"packages/extension-api/src/extension-api.d.ts:2895"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"throttled_time",children:"throttled_time"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"throttled_time"}),": ",(0,r.jsx)(t.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})})]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>o});var r=n(27378);const i={},s=r.createContext(i);function o(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f86eb50f.715530bf.js b/assets/js/f86eb50f.2df0e57b.js similarity index 95% rename from assets/js/f86eb50f.715530bf.js rename to assets/js/f86eb50f.2df0e57b.js index fce96c50bec..f3850788549 100644 --- a/assets/js/f86eb50f.715530bf.js +++ b/assets/js/f86eb50f.2df0e57b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{67108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ContainerProviderConnectionFactory",s={id:"interfaces/ContainerProviderConnectionFactory",title:"Interface: ContainerProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/ContainerProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"},next:{title:"ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnectionfactory",children:"Interface: ContainerProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L360",children:"packages/extension-api/src/extension-api.d.ts:360"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{67108:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const t={},c="Interface: ContainerProviderConnectionFactory",s={id:"interfaces/ContainerProviderConnectionFactory",title:"Interface: ContainerProviderConnectionFactory",description:"Extends",source:"@site/api/interfaces/ContainerProviderConnectionFactory.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerProviderConnectionFactory",permalink:"/api/interfaces/ContainerProviderConnectionFactory",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerProviderConnectionEndpoint",permalink:"/api/interfaces/ContainerProviderConnectionEndpoint"},next:{title:"ContainerStatsInfo",permalink:"/api/interfaces/ContainerStatsInfo"}},d={},a=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"creationButtonTitle?",id:"creationbuttontitle",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Source",id:"source",level:4},{value:"creationDisplayName?",id:"creationdisplayname",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Source",id:"source-1",level:4},{value:"Methods",id:"methods",level:2},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Source",id:"source-2",level:4},{value:"initialize()?",id:"initialize",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-containerproviderconnectionfactory",children:"Interface: ContainerProviderConnectionFactory"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"creationbuttontitle",children:"creationButtonTitle?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationButtonTitle"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationbuttontitle",children:(0,r.jsx)(n.code,{children:"creationButtonTitle"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L354",children:"packages/extension-api/src/extension-api.d.ts:354"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"creationdisplayname",children:"creationDisplayName?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"creationDisplayName"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#creationdisplayname",children:(0,r.jsx)(n.code,{children:"creationDisplayName"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L351",children:"packages/extension-api/src/extension-api.d.ts:351"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"create",children:"create()"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"create"}),"(",(0,r.jsx)(n.code,{children:"params"}),", ",(0,r.jsx)(n.code,{children:"logger"}),"?, ",(0,r.jsx)(n.code,{children:"token"}),"?): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"params"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"logger?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,r.jsx)(n.code,{children:"Logger"})})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"token?"}),": ",(0,r.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,r.jsx)(n.code,{children:"CancellationToken"})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L360",children:"packages/extension-api/src/extension-api.d.ts:360"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"initialize",children:"initialize()?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"initialize"}),"(): ",(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory",children:(0,r.jsx)(n.code,{children:"ProviderConnectionFactory"})})," . ",(0,r.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionFactory#initialize",children:(0,r.jsx)(n.code,{children:"initialize"})})]}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L348",children:"packages/extension-api/src/extension-api.d.ts:348"})})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>s,a:()=>c});var r=i(27378);const o={},t=r.createContext(o);function c(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb8cd692.ed06781d.js b/assets/js/fb8cd692.3d027e82.js similarity index 85% rename from assets/js/fb8cd692.ed06781d.js rename to assets/js/fb8cd692.3d027e82.js index 488e86d5c3d..262e33831aa 100644 --- a/assets/js/fb8cd692.ed06781d.js +++ b/assets/js/fb8cd692.3d027e82.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{92985:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>t});var i=s(24246),c=s(71670);const o={},d="Interface: HostConfig",r={id:"interfaces/HostConfig",title:"Interface: HostConfig",description:"Properties",source:"@site/api/interfaces/HostConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HostConfig",permalink:"/api/interfaces/HostConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthConfig",permalink:"/api/interfaces/HealthConfig"},next:{title:"HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"}},l={},t=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Source",id:"source",level:4},{value:"Binds?",id:"binds",level:3},{value:"Source",id:"source-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Source",id:"source-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Source",id:"source-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Source",id:"source-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Source",id:"source-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Source",id:"source-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Source",id:"source-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Source",id:"source-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Source",id:"source-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Source",id:"source-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Source",id:"source-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Source",id:"source-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Source",id:"source-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Source",id:"source-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Source",id:"source-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Source",id:"source-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Source",id:"source-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Source",id:"source-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Source",id:"source-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Source",id:"source-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Source",id:"source-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Source",id:"source-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Source",id:"source-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Source",id:"source-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Source",id:"source-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Source",id:"source-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Source",id:"source-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Source",id:"source-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Source",id:"source-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Source",id:"source-31",level:4},{value:"Init?",id:"init",level:3},{value:"Source",id:"source-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Source",id:"source-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Source",id:"source-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Source",id:"source-35",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Source",id:"source-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Source",id:"source-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Source",id:"source-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Source",id:"source-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Source",id:"source-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Source",id:"source-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Source",id:"source-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Source",id:"source-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Source",id:"source-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Source",id:"source-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Source",id:"source-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Source",id:"source-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Source",id:"source-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Source",id:"source-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Source",id:"source-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Source",id:"source-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Source",id:"source-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Source",id:"source-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Source",id:"source-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Source",id:"source-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Source",id:"source-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Source",id:"source-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Source",id:"source-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Source",id:"source-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Source",id:"source-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Source",id:"source-66",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AutoRemove"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Binds"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2214",children:"packages/extension-api/src/extension-api.d.ts:2214"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2213",children:"packages/extension-api/src/extension-api.d.ts:2213"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2215",children:"packages/extension-api/src/extension-api.d.ts:2215"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioWeight"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2210",children:"packages/extension-api/src/extension-api.d.ts:2210"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioWeightDevice"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2211",children:"packages/extension-api/src/extension-api.d.ts:2211"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CapAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CapDrop"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CgroupParent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2209",children:"packages/extension-api/src/extension-api.d.ts:2209"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ConsoleSize"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2204",children:"packages/extension-api/src/extension-api.d.ts:2204"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ContainerIDFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2234",children:"packages/extension-api/src/extension-api.d.ts:2234"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuPercent"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2235",children:"packages/extension-api/src/extension-api.d.ts:2235"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuPeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2216",children:"packages/extension-api/src/extension-api.d.ts:2216"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2217",children:"packages/extension-api/src/extension-api.d.ts:2217"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimePeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2236",children:"packages/extension-api/src/extension-api.d.ts:2236"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimeRuntime"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2237",children:"packages/extension-api/src/extension-api.d.ts:2237"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuShares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpusetCpus"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2218",children:"packages/extension-api/src/extension-api.d.ts:2218"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpusetMems"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2219",children:"packages/extension-api/src/extension-api.d.ts:2219"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DeviceCgroupRules"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2221",children:"packages/extension-api/src/extension-api.d.ts:2221"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DeviceRequests"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,i.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2222",children:"packages/extension-api/src/extension-api.d.ts:2222"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Devices"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2220",children:"packages/extension-api/src/extension-api.d.ts:2220"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DiskQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2223",children:"packages/extension-api/src/extension-api.d.ts:2223"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Dns"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DnsOptions"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DnsSearch"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExtraHosts"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GroupAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"init",children:"Init?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Init"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IpcMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-33",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Isolation"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-34",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2205",children:"packages/extension-api/src/extension-api.d.ts:2205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"KernelMemory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-35",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2224",children:"packages/extension-api/src/extension-api.d.ts:2224"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-36",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LogConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-37",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MaskedPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-38",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2206",children:"packages/extension-api/src/extension-api.d.ts:2206"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-39",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2225",children:"packages/extension-api/src/extension-api.d.ts:2225"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemoryReservation"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-40",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2226",children:"packages/extension-api/src/extension-api.d.ts:2226"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemorySwap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-41",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2227",children:"packages/extension-api/src/extension-api.d.ts:2227"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemorySwappiness"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-42",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2228",children:"packages/extension-api/src/extension-api.d.ts:2228"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,i.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-43",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NanoCpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-44",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2229",children:"packages/extension-api/src/extension-api.d.ts:2229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-45",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2175",children:"packages/extension-api/src/extension-api.d.ts:2175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OomKillDisable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-46",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2230",children:"packages/extension-api/src/extension-api.d.ts:2230"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OomScoreAdj"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-47",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PidMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-48",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2192",children:"packages/extension-api/src/extension-api.d.ts:2192"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PidsLimit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-49",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2232",children:"packages/extension-api/src/extension-api.d.ts:2232"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PortBindings"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-50",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Privileged"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-51",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2193",children:"packages/extension-api/src/extension-api.d.ts:2193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PublishAllPorts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-52",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2194",children:"packages/extension-api/src/extension-api.d.ts:2194"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadonlyPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-53",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2207",children:"packages/extension-api/src/extension-api.d.ts:2207"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadonlyRootfs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-54",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2195",children:"packages/extension-api/src/extension-api.d.ts:2195"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"RestartPolicy"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,i.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-55",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Runtime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-56",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2203",children:"packages/extension-api/src/extension-api.d.ts:2203"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecurityOpt"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-57",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2196",children:"packages/extension-api/src/extension-api.d.ts:2196"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ShmSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-58",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2201",children:"packages/extension-api/src/extension-api.d.ts:2201"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StorageOpt"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-59",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2197",children:"packages/extension-api/src/extension-api.d.ts:2197"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Sysctls"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"index"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-60",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2202",children:"packages/extension-api/src/extension-api.d.ts:2202"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Tmpfs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"dir"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-61",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2198",children:"packages/extension-api/src/extension-api.d.ts:2198"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UTSMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-62",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2199",children:"packages/extension-api/src/extension-api.d.ts:2199"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Ulimits"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-63",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UsernsMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-64",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2200",children:"packages/extension-api/src/extension-api.d.ts:2200"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumeDriver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-65",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumesFrom"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-66",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>d});var i=s(27378);const c={},o=i.createContext(c);function d(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:d(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{92985:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>t});var i=s(24246),c=s(71670);const o={},r="Interface: HostConfig",d={id:"interfaces/HostConfig",title:"Interface: HostConfig",description:"Properties",source:"@site/api/interfaces/HostConfig.md",sourceDirName:"interfaces",slug:"/interfaces/HostConfig",permalink:"/api/interfaces/HostConfig",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"HealthConfig",permalink:"/api/interfaces/HealthConfig"},next:{title:"HostRestartPolicy",permalink:"/api/interfaces/HostRestartPolicy"}},l={},t=[{value:"Properties",id:"properties",level:2},{value:"AutoRemove?",id:"autoremove",level:3},{value:"Source",id:"source",level:4},{value:"Binds?",id:"binds",level:3},{value:"Source",id:"source-1",level:4},{value:"BlkioDeviceReadBps?",id:"blkiodevicereadbps",level:3},{value:"Source",id:"source-2",level:4},{value:"BlkioDeviceReadIOps?",id:"blkiodevicereadiops",level:3},{value:"Source",id:"source-3",level:4},{value:"BlkioDeviceWriteBps?",id:"blkiodevicewritebps",level:3},{value:"Source",id:"source-4",level:4},{value:"BlkioDeviceWriteIOps?",id:"blkiodevicewriteiops",level:3},{value:"Source",id:"source-5",level:4},{value:"BlkioWeight?",id:"blkioweight",level:3},{value:"Source",id:"source-6",level:4},{value:"BlkioWeightDevice?",id:"blkioweightdevice",level:3},{value:"Source",id:"source-7",level:4},{value:"CapAdd?",id:"capadd",level:3},{value:"Source",id:"source-8",level:4},{value:"CapDrop?",id:"capdrop",level:3},{value:"Source",id:"source-9",level:4},{value:"Cgroup?",id:"cgroup",level:3},{value:"Source",id:"source-10",level:4},{value:"CgroupParent?",id:"cgroupparent",level:3},{value:"Source",id:"source-11",level:4},{value:"ConsoleSize?",id:"consolesize",level:3},{value:"Source",id:"source-12",level:4},{value:"ContainerIDFile?",id:"containeridfile",level:3},{value:"Source",id:"source-13",level:4},{value:"CpuCount?",id:"cpucount",level:3},{value:"Source",id:"source-14",level:4},{value:"CpuPercent?",id:"cpupercent",level:3},{value:"Source",id:"source-15",level:4},{value:"CpuPeriod?",id:"cpuperiod",level:3},{value:"Source",id:"source-16",level:4},{value:"CpuQuota?",id:"cpuquota",level:3},{value:"Source",id:"source-17",level:4},{value:"CpuRealtimePeriod?",id:"cpurealtimeperiod",level:3},{value:"Source",id:"source-18",level:4},{value:"CpuRealtimeRuntime?",id:"cpurealtimeruntime",level:3},{value:"Source",id:"source-19",level:4},{value:"CpuShares?",id:"cpushares",level:3},{value:"Source",id:"source-20",level:4},{value:"CpusetCpus?",id:"cpusetcpus",level:3},{value:"Source",id:"source-21",level:4},{value:"CpusetMems?",id:"cpusetmems",level:3},{value:"Source",id:"source-22",level:4},{value:"DeviceCgroupRules?",id:"devicecgrouprules",level:3},{value:"Source",id:"source-23",level:4},{value:"DeviceRequests?",id:"devicerequests",level:3},{value:"Source",id:"source-24",level:4},{value:"Devices?",id:"devices",level:3},{value:"Source",id:"source-25",level:4},{value:"DiskQuota?",id:"diskquota",level:3},{value:"Source",id:"source-26",level:4},{value:"Dns?",id:"dns",level:3},{value:"Source",id:"source-27",level:4},{value:"DnsOptions?",id:"dnsoptions",level:3},{value:"Source",id:"source-28",level:4},{value:"DnsSearch?",id:"dnssearch",level:3},{value:"Source",id:"source-29",level:4},{value:"ExtraHosts?",id:"extrahosts",level:3},{value:"Source",id:"source-30",level:4},{value:"GroupAdd?",id:"groupadd",level:3},{value:"Source",id:"source-31",level:4},{value:"Init?",id:"init",level:3},{value:"Source",id:"source-32",level:4},{value:"IpcMode?",id:"ipcmode",level:3},{value:"Source",id:"source-33",level:4},{value:"Isolation?",id:"isolation",level:3},{value:"Source",id:"source-34",level:4},{value:"KernelMemory?",id:"kernelmemory",level:3},{value:"Source",id:"source-35",level:4},{value:"Links?",id:"links",level:3},{value:"Source",id:"source-36",level:4},{value:"LogConfig?",id:"logconfig",level:3},{value:"Config",id:"config",level:4},{value:"Type",id:"type",level:4},{value:"Source",id:"source-37",level:4},{value:"MaskedPaths?",id:"maskedpaths",level:3},{value:"Source",id:"source-38",level:4},{value:"Memory?",id:"memory",level:3},{value:"Source",id:"source-39",level:4},{value:"MemoryReservation?",id:"memoryreservation",level:3},{value:"Source",id:"source-40",level:4},{value:"MemorySwap?",id:"memoryswap",level:3},{value:"Source",id:"source-41",level:4},{value:"MemorySwappiness?",id:"memoryswappiness",level:3},{value:"Source",id:"source-42",level:4},{value:"Mounts?",id:"mounts",level:3},{value:"Source",id:"source-43",level:4},{value:"NanoCpus?",id:"nanocpus",level:3},{value:"Source",id:"source-44",level:4},{value:"NetworkMode?",id:"networkmode",level:3},{value:"Source",id:"source-45",level:4},{value:"OomKillDisable?",id:"oomkilldisable",level:3},{value:"Source",id:"source-46",level:4},{value:"OomScoreAdj?",id:"oomscoreadj",level:3},{value:"Source",id:"source-47",level:4},{value:"PidMode?",id:"pidmode",level:3},{value:"Source",id:"source-48",level:4},{value:"PidsLimit?",id:"pidslimit",level:3},{value:"Source",id:"source-49",level:4},{value:"PortBindings?",id:"portbindings",level:3},{value:"Source",id:"source-50",level:4},{value:"Privileged?",id:"privileged",level:3},{value:"Source",id:"source-51",level:4},{value:"PublishAllPorts?",id:"publishallports",level:3},{value:"Source",id:"source-52",level:4},{value:"ReadonlyPaths?",id:"readonlypaths",level:3},{value:"Source",id:"source-53",level:4},{value:"ReadonlyRootfs?",id:"readonlyrootfs",level:3},{value:"Source",id:"source-54",level:4},{value:"RestartPolicy?",id:"restartpolicy",level:3},{value:"Source",id:"source-55",level:4},{value:"Runtime?",id:"runtime",level:3},{value:"Source",id:"source-56",level:4},{value:"SecurityOpt?",id:"securityopt",level:3},{value:"Source",id:"source-57",level:4},{value:"ShmSize?",id:"shmsize",level:3},{value:"Source",id:"source-58",level:4},{value:"StorageOpt?",id:"storageopt",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Source",id:"source-59",level:4},{value:"Sysctls?",id:"sysctls",level:3},{value:"Index signature",id:"index-signature-1",level:4},{value:"Source",id:"source-60",level:4},{value:"Tmpfs?",id:"tmpfs",level:3},{value:"Index signature",id:"index-signature-2",level:4},{value:"Source",id:"source-61",level:4},{value:"UTSMode?",id:"utsmode",level:3},{value:"Source",id:"source-62",level:4},{value:"Ulimits?",id:"ulimits",level:3},{value:"Source",id:"source-63",level:4},{value:"UsernsMode?",id:"usernsmode",level:3},{value:"Source",id:"source-64",level:4},{value:"VolumeDriver?",id:"volumedriver",level:3},{value:"Source",id:"source-65",level:4},{value:"VolumesFrom?",id:"volumesfrom",level:3},{value:"Source",id:"source-66",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"AutoRemove"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Binds"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2212",children:"packages/extension-api/src/extension-api.d.ts:2212"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceReadIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2214",children:"packages/extension-api/src/extension-api.d.ts:2214"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteBps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2213",children:"packages/extension-api/src/extension-api.d.ts:2213"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioDeviceWriteIOps"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2215",children:"packages/extension-api/src/extension-api.d.ts:2215"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioWeight"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2210",children:"packages/extension-api/src/extension-api.d.ts:2210"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"BlkioWeightDevice"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2211",children:"packages/extension-api/src/extension-api.d.ts:2211"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CapAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2181",children:"packages/extension-api/src/extension-api.d.ts:2181"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CapDrop"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2182",children:"packages/extension-api/src/extension-api.d.ts:2182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Cgroup"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2189",children:"packages/extension-api/src/extension-api.d.ts:2189"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CgroupParent"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2209",children:"packages/extension-api/src/extension-api.d.ts:2209"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ConsoleSize"}),": ",(0,i.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2204",children:"packages/extension-api/src/extension-api.d.ts:2204"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ContainerIDFile"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuCount"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2234",children:"packages/extension-api/src/extension-api.d.ts:2234"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuPercent"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2235",children:"packages/extension-api/src/extension-api.d.ts:2235"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuPeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2216",children:"packages/extension-api/src/extension-api.d.ts:2216"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2217",children:"packages/extension-api/src/extension-api.d.ts:2217"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimePeriod"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2236",children:"packages/extension-api/src/extension-api.d.ts:2236"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuRealtimeRuntime"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2237",children:"packages/extension-api/src/extension-api.d.ts:2237"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpuShares"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2208",children:"packages/extension-api/src/extension-api.d.ts:2208"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpusetCpus"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2218",children:"packages/extension-api/src/extension-api.d.ts:2218"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"CpusetMems"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2219",children:"packages/extension-api/src/extension-api.d.ts:2219"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DeviceCgroupRules"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2221",children:"packages/extension-api/src/extension-api.d.ts:2221"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DeviceRequests"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,i.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2222",children:"packages/extension-api/src/extension-api.d.ts:2222"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Devices"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2220",children:"packages/extension-api/src/extension-api.d.ts:2220"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DiskQuota"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2223",children:"packages/extension-api/src/extension-api.d.ts:2223"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Dns"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2183",children:"packages/extension-api/src/extension-api.d.ts:2183"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DnsOptions"}),": ",(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2184",children:"packages/extension-api/src/extension-api.d.ts:2184"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"DnsSearch"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2185",children:"packages/extension-api/src/extension-api.d.ts:2185"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ExtraHosts"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2186",children:"packages/extension-api/src/extension-api.d.ts:2186"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"GroupAdd"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2187",children:"packages/extension-api/src/extension-api.d.ts:2187"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"init",children:"Init?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Init"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2231",children:"packages/extension-api/src/extension-api.d.ts:2231"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"IpcMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-33",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2188",children:"packages/extension-api/src/extension-api.d.ts:2188"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Isolation"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-34",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2205",children:"packages/extension-api/src/extension-api.d.ts:2205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"KernelMemory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-35",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2224",children:"packages/extension-api/src/extension-api.d.ts:2224"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"links",children:"Links?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Links"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-36",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"LogConfig"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Config"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Type"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-37",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MaskedPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-38",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2206",children:"packages/extension-api/src/extension-api.d.ts:2206"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Memory"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-39",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2225",children:"packages/extension-api/src/extension-api.d.ts:2225"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemoryReservation"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-40",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2226",children:"packages/extension-api/src/extension-api.d.ts:2226"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemorySwap"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-41",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2227",children:"packages/extension-api/src/extension-api.d.ts:2227"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"MemorySwappiness"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-42",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2228",children:"packages/extension-api/src/extension-api.d.ts:2228"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Mounts"}),": ",(0,i.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,i.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-43",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2180",children:"packages/extension-api/src/extension-api.d.ts:2180"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NanoCpus"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-44",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2229",children:"packages/extension-api/src/extension-api.d.ts:2229"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"NetworkMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-45",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2175",children:"packages/extension-api/src/extension-api.d.ts:2175"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OomKillDisable"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-46",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2230",children:"packages/extension-api/src/extension-api.d.ts:2230"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"OomScoreAdj"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-47",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PidMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-48",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2192",children:"packages/extension-api/src/extension-api.d.ts:2192"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PidsLimit"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-49",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2232",children:"packages/extension-api/src/extension-api.d.ts:2232"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PortBindings"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-50",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Privileged"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-51",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2193",children:"packages/extension-api/src/extension-api.d.ts:2193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"PublishAllPorts"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-52",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2194",children:"packages/extension-api/src/extension-api.d.ts:2194"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadonlyPaths"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-53",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2207",children:"packages/extension-api/src/extension-api.d.ts:2207"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ReadonlyRootfs"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-54",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2195",children:"packages/extension-api/src/extension-api.d.ts:2195"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"RestartPolicy"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,i.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-55",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Runtime"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-56",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2203",children:"packages/extension-api/src/extension-api.d.ts:2203"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"SecurityOpt"}),": ",(0,i.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-57",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2196",children:"packages/extension-api/src/extension-api.d.ts:2196"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"ShmSize"}),": ",(0,i.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-58",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2201",children:"packages/extension-api/src/extension-api.d.ts:2201"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"StorageOpt"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-59",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2197",children:"packages/extension-api/src/extension-api.d.ts:2197"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Sysctls"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"index"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-60",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2202",children:"packages/extension-api/src/extension-api.d.ts:2202"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Tmpfs"}),": ",(0,i.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,i.jsxs)(n.p,{children:["[",(0,i.jsx)(n.code,{children:"dir"}),": ",(0,i.jsx)(n.code,{children:"string"}),"]: ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h4,{id:"source-61",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2198",children:"packages/extension-api/src/extension-api.d.ts:2198"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UTSMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-62",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2199",children:"packages/extension-api/src/extension-api.d.ts:2199"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"Ulimits"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-63",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"UsernsMode"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-64",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2200",children:"packages/extension-api/src/extension-api.d.ts:2200"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumeDriver"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-65",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"VolumesFrom"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,i.jsx)(n.h4,{id:"source-66",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>d,a:()=>r});var i=s(27378);const c={},o=i.createContext(c);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbfd390f.e841d180.js b/assets/js/fbfd390f.fccd079a.js similarity index 94% rename from assets/js/fbfd390f.e841d180.js rename to assets/js/fbfd390f.fccd079a.js index b7261975b7b..615fe5469ff 100644 --- a/assets/js/fbfd390f.e841d180.js +++ b/assets/js/fbfd390f.fccd079a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{83930:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=n(24246),s=n(71670);const i={},c="Interface: AuditResult",o={id:"interfaces/AuditResult",title:"Interface: AuditResult",description:"Properties",source:"@site/api/interfaces/AuditResult.md",sourceDirName:"interfaces",slug:"/interfaces/AuditResult",permalink:"/api/interfaces/AuditResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"},next:{title:"Auditor",permalink:"/api/interfaces/Auditor"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"records",id:"records",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"records"}),": ",(0,r.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,r.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L375",children:"packages/extension-api/src/extension-api.d.ts:375"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const s={},i=r.createContext(s);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{83930:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var r=n(24246),s=n(71670);const i={},c="Interface: AuditResult",o={id:"interfaces/AuditResult",title:"Interface: AuditResult",description:"Properties",source:"@site/api/interfaces/AuditResult.md",sourceDirName:"interfaces",slug:"/interfaces/AuditResult",permalink:"/api/interfaces/AuditResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"AuditRequestItems",permalink:"/api/interfaces/AuditRequestItems"},next:{title:"Auditor",permalink:"/api/interfaces/Auditor"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"records",id:"records",level:3},{value:"Source",id:"source",level:4}];function u(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-auditresult",children:"Interface: AuditResult"}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"records",children:"records"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.strong,{children:"records"}),": ",(0,r.jsx)(t.a,{href:"/api/interfaces/AuditRecord",children:(0,r.jsx)(t.code,{children:"AuditRecord"})}),"[]"]}),"\n"]}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L375",children:"packages/extension-api/src/extension-api.d.ts:375"})})]})}function l(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const s={},i=r.createContext(s);function c(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fc923f19.a56c7545.js b/assets/js/fc923f19.a8b94c1d.js similarity index 92% rename from assets/js/fc923f19.a56c7545.js rename to assets/js/fc923f19.a8b94c1d.js index 0b6444ecaa3..20b262abb36 100644 --- a/assets/js/fc923f19.a56c7545.js +++ b/assets/js/fc923f19.a8b94c1d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{84974:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const c={},t="Interface: ImageCheck",o={id:"interfaces/ImageCheck",title:"Interface: ImageCheck",description:"a specific error/recommendation found during an image check",source:"@site/api/interfaces/ImageCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheck",permalink:"/api/interfaces/ImageCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"IPAM",permalink:"/api/interfaces/IPAM"},next:{title:"ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Source",id:"source-2",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,r.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4126",children:"packages/extension-api/src/extension-api.d.ts:4126"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"a short and descriptive name for the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4114",children:"packages/extension-api/src/extension-api.d.ts:4114"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"severity",children:"severity?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"severity"}),": ",(0,r.jsx)(n.code,{children:'"high"'})," | ",(0,r.jsx)(n.code,{children:'"low"'})," | ",(0,r.jsx)(n.code,{children:'"medium"'})," | ",(0,r.jsx)(n.code,{children:'"critical"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["severity of the error/recommendation, when the status is ",(0,r.jsx)(n.code,{children:"failed"})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4122",children:"packages/extension-api/src/extension-api.d.ts:4122"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:'"failed"'})," | ",(0,r.jsx)(n.code,{children:'"success"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"either the feedback is positive or negative"}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4118",children:"packages/extension-api/src/extension-api.d.ts:4118"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{84974:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=s(24246),i=s(71670);const c={},t="Interface: ImageCheck",o={id:"interfaces/ImageCheck",title:"Interface: ImageCheck",description:"a specific error/recommendation found during an image check",source:"@site/api/interfaces/ImageCheck.md",sourceDirName:"interfaces",slug:"/interfaces/ImageCheck",permalink:"/api/interfaces/ImageCheck",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"IPAM",permalink:"/api/interfaces/IPAM"},next:{title:"ImageCheckerProvider",permalink:"/api/interfaces/ImageCheckerProvider"}},a={},d=[{value:"Properties",id:"properties",level:2},{value:"markdownDescription?",id:"markdowndescription",level:3},{value:"Source",id:"source",level:4},{value:"name",id:"name",level:3},{value:"Source",id:"source-1",level:4},{value:"severity?",id:"severity",level:3},{value:"Source",id:"source-2",level:4},{value:"status",id:"status",level:3},{value:"Source",id:"source-3",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,r.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"markdownDescription"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"full description of the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4126",children:"packages/extension-api/src/extension-api.d.ts:4126"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"a short and descriptive name for the error/recommendation"}),"\n",(0,r.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4114",children:"packages/extension-api/src/extension-api.d.ts:4114"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"severity",children:"severity?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"severity"}),": ",(0,r.jsx)(n.code,{children:'"high"'})," | ",(0,r.jsx)(n.code,{children:'"low"'})," | ",(0,r.jsx)(n.code,{children:'"medium"'})," | ",(0,r.jsx)(n.code,{children:'"critical"'})]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["severity of the error/recommendation, when the status is ",(0,r.jsx)(n.code,{children:"failed"})]}),"\n",(0,r.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4122",children:"packages/extension-api/src/extension-api.d.ts:4122"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"status",children:"status"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"status"}),": ",(0,r.jsx)(n.code,{children:'"failed"'})," | ",(0,r.jsx)(n.code,{children:'"success"'})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"either the feedback is positive or negative"}),"\n",(0,r.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4118",children:"packages/extension-api/src/extension-api.d.ts:4118"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>t});var r=s(27378);const i={},c=r.createContext(i);function t(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd702dc7.e350ee84.js b/assets/js/fd702dc7.07e2a99c.js similarity index 97% rename from assets/js/fd702dc7.e350ee84.js rename to assets/js/fd702dc7.07e2a99c.js index 491922c980e..cc29a6cbb5b 100644 --- a/assets/js/fd702dc7.e350ee84.js +++ b/assets/js/fd702dc7.07e2a99c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{81583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var o=t(24246),s=t(71670);const r={},i="Interface: WebviewOptions",c={id:"interfaces/WebviewOptions",title:"Interface: WebviewOptions",description:"Content settings for a webview.",source:"@site/api/interfaces/WebviewOptions.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewOptions",permalink:"/api/interfaces/WebviewOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewInfo",permalink:"/api/interfaces/WebviewInfo"},next:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"localResourceRoots?",id:"localresourceroots",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-webviewoptions",children:"Interface: WebviewOptions"}),"\n",(0,o.jsx)(n.p,{children:"Content settings for a webview."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"localresourceroots",children:"localResourceRoots?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.strong,{children:"localResourceRoots"}),": readonly ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[]"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Root paths from which the webview can load local (filesystem) resources using uris from ",(0,o.jsx)(n.code,{children:"asWebviewUri"})]}),"\n",(0,o.jsx)(n.p,{children:"Default to the root folders of the current workspace plus the extension's install directory."}),"\n",(0,o.jsx)(n.p,{children:"Pass in an empty array to disallow access to any local resources."}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L1429",children:"packages/extension-api/src/extension-api.d.ts:1429"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var o=t(27378);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{81583:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>l});var o=t(24246),s=t(71670);const r={},i="Interface: WebviewOptions",c={id:"interfaces/WebviewOptions",title:"Interface: WebviewOptions",description:"Content settings for a webview.",source:"@site/api/interfaces/WebviewOptions.md",sourceDirName:"interfaces",slug:"/interfaces/WebviewOptions",permalink:"/api/interfaces/WebviewOptions",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"WebviewInfo",permalink:"/api/interfaces/WebviewInfo"},next:{title:"WebviewPanel",permalink:"/api/interfaces/WebviewPanel"}},a={},l=[{value:"Properties",id:"properties",level:2},{value:"localResourceRoots?",id:"localresourceroots",level:3},{value:"Source",id:"source",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"interface-webviewoptions",children:"Interface: WebviewOptions"}),"\n",(0,o.jsx)(n.p,{children:"Content settings for a webview."}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"localresourceroots",children:"localResourceRoots?"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"optional"})," ",(0,o.jsx)(n.code,{children:"readonly"})," ",(0,o.jsx)(n.strong,{children:"localResourceRoots"}),": readonly ",(0,o.jsx)(n.a,{href:"/api/classes/Uri",children:(0,o.jsx)(n.code,{children:"Uri"})}),"[]"]}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Root paths from which the webview can load local (filesystem) resources using uris from ",(0,o.jsx)(n.code,{children:"asWebviewUri"})]}),"\n",(0,o.jsx)(n.p,{children:"Default to the root folders of the current workspace plus the extension's install directory."}),"\n",(0,o.jsx)(n.p,{children:"Pass in an empty array to disallow access to any local resources."}),"\n",(0,o.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L1429",children:"packages/extension-api/src/extension-api.d.ts:1429"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var o=t(27378);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe1a05e2.5138b9c7.js b/assets/js/fe1a05e2.77d044b4.js similarity index 96% rename from assets/js/fe1a05e2.5138b9c7.js rename to assets/js/fe1a05e2.77d044b4.js index f90fe25f129..395aa5d38cb 100644 --- a/assets/js/fe1a05e2.5138b9c7.js +++ b/assets/js/fe1a05e2.77d044b4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70900],{22826:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Function: registerProviderMenuItem()",c={id:"namespaces/tray/functions/registerProviderMenuItem",title:"Function: registerProviderMenuItem()",description:"registerProviderMenuItem(providerId, item): Disposable",source:"@site/api/namespaces/tray/functions/registerProviderMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem"},next:{title:"Namespace: window",permalink:"/api/namespaces/window/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerprovidermenuitem",children:"Function: registerProviderMenuItem()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerProviderMenuItem"}),"(",(0,t.jsx)(r.code,{children:"providerId"}),", ",(0,t.jsx)(r.code,{children:"item"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Creates a menu in the tray for a given Provider"}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"providerId"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n",(0,t.jsx)(r.p,{children:"the same as the id on Provider provided by createProvider() method, need to place menu item properly"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"item"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/MenuItem",children:(0,t.jsx)(r.code,{children:"MenuItem"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L685",children:"packages/extension-api/src/extension-api.d.ts:685"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70900],{22826:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=n(24246),s=n(71670);const i={},o="Function: registerProviderMenuItem()",c={id:"namespaces/tray/functions/registerProviderMenuItem",title:"Function: registerProviderMenuItem()",description:"registerProviderMenuItem(providerId, item): Disposable",source:"@site/api/namespaces/tray/functions/registerProviderMenuItem.md",sourceDirName:"namespaces/tray/functions",slug:"/namespaces/tray/functions/registerProviderMenuItem",permalink:"/api/namespaces/tray/functions/registerProviderMenuItem",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"registerMenuItem",permalink:"/api/namespaces/tray/functions/registerMenuItem"},next:{title:"Namespace: window",permalink:"/api/namespaces/window/"}},a={},d=[{value:"Parameters",id:"parameters",level:2},{value:"Returns",id:"returns",level:2},{value:"Source",id:"source",level:2}];function p(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h1,{id:"function-registerprovidermenuitem",children:"Function: registerProviderMenuItem()"}),"\n",(0,t.jsxs)(r.blockquote,{children:["\n",(0,t.jsxs)(r.p,{children:[(0,t.jsx)(r.strong,{children:"registerProviderMenuItem"}),"(",(0,t.jsx)(r.code,{children:"providerId"}),", ",(0,t.jsx)(r.code,{children:"item"}),"): ",(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,t.jsx)(r.p,{children:"Creates a menu in the tray for a given Provider"}),"\n",(0,t.jsx)(r.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"providerId"}),": ",(0,t.jsx)(r.code,{children:"string"})]}),"\n",(0,t.jsx)(r.p,{children:"the same as the id on Provider provided by createProvider() method, need to place menu item properly"}),"\n",(0,t.jsxs)(r.p,{children:["\u2022 ",(0,t.jsx)(r.strong,{children:"item"}),": ",(0,t.jsx)(r.a,{href:"/api/interfaces/MenuItem",children:(0,t.jsx)(r.code,{children:"MenuItem"})})]}),"\n",(0,t.jsx)(r.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"/api/classes/Disposable",children:(0,t.jsx)(r.code,{children:"Disposable"})})}),"\n",(0,t.jsx)(r.h2,{id:"source",children:"Source"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L685",children:"packages/extension-api/src/extension-api.d.ts:685"})})]})}function u(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},71670:(e,r,n)=>{n.d(r,{Z:()=>c,a:()=>o});var t=n(27378);const s={},i=t.createContext(s);function o(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe716911.01292867.js b/assets/js/fe716911.876d6afb.js similarity index 82% rename from assets/js/fe716911.01292867.js rename to assets/js/fe716911.876d6afb.js index 9ad58178289..54704f07621 100644 --- a/assets/js/fe716911.01292867.js +++ b/assets/js/fe716911.876d6afb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{36151:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var c=s(24246),i=s(71670);const o={},t="Interface: CheckResult",r={id:"interfaces/CheckResult",title:"Interface: CheckResult",description:"Properties",source:"@site/api/interfaces/CheckResult.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResult",permalink:"/api/interfaces/CheckResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CancellationToken",permalink:"/api/interfaces/CancellationToken"},next:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Source",id:"source-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Source",id:"source-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Source",id:"source-3",level:4},{value:"successful",id:"successful",level:3},{value:"Source",id:"source-4",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"description"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L401",children:"packages/extension-api/src/extension-api.d.ts:401"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"docLinks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,c.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L403",children:"packages/extension-api/src/extension-api.d.ts:403"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"docLinksDescription"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L402",children:"packages/extension-api/src/extension-api.d.ts:402"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"fixCommand"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,c.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L404",children:"packages/extension-api/src/extension-api.d.ts:404"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"successful"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L400",children:"packages/extension-api/src/extension-api.d.ts:400"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>t});var c=s(27378);const i={},o=c.createContext(i);function t(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{36151:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var c=s(24246),i=s(71670);const o={},t="Interface: CheckResult",r={id:"interfaces/CheckResult",title:"Interface: CheckResult",description:"Properties",source:"@site/api/interfaces/CheckResult.md",sourceDirName:"interfaces",slug:"/interfaces/CheckResult",permalink:"/api/interfaces/CheckResult",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"CancellationToken",permalink:"/api/interfaces/CancellationToken"},next:{title:"CheckResultFixCommand",permalink:"/api/interfaces/CheckResultFixCommand"}},d={},l=[{value:"Properties",id:"properties",level:2},{value:"description?",id:"description",level:3},{value:"Source",id:"source",level:4},{value:"docLinks?",id:"doclinks",level:3},{value:"Source",id:"source-1",level:4},{value:"docLinksDescription?",id:"doclinksdescription",level:3},{value:"Source",id:"source-2",level:4},{value:"fixCommand?",id:"fixcommand",level:3},{value:"Source",id:"source-3",level:4},{value:"successful",id:"successful",level:3},{value:"Source",id:"source-4",level:4}];function a(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"description",children:"description?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"description"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L401",children:"packages/extension-api/src/extension-api.d.ts:401"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"docLinks"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Link",children:(0,c.jsx)(n.code,{children:"Link"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L403",children:"packages/extension-api/src/extension-api.d.ts:403"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"docLinksDescription"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L402",children:"packages/extension-api/src/extension-api.d.ts:402"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.code,{children:"optional"})," ",(0,c.jsx)(n.strong,{children:"fixCommand"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,c.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L404",children:"packages/extension-api/src/extension-api.d.ts:404"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"successful"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L400",children:"packages/extension-api/src/extension-api.d.ts:400"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>t});var c=s(27378);const i={},o=c.createContext(i);function t(e){const n=c.useContext(o);return c.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fee0a0be.d4da6a09.js b/assets/js/fee0a0be.c074b613.js similarity index 79% rename from assets/js/fee0a0be.d4da6a09.js rename to assets/js/fee0a0be.c074b613.js index 25daa4dbb04..f179c4a71db 100644 --- a/assets/js/fee0a0be.d4da6a09.js +++ b/assets/js/fee0a0be.c074b613.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{97294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>a});var s=i(24246),r=i(71670);const o={},c="Interface: ContainerEngineInfo",d={id:"interfaces/ContainerEngineInfo",title:"Interface: ContainerEngineInfo",description:"Resources information about a container engine",source:"@site/api/interfaces/ContainerEngineInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"},next:{title:"ContainerInfo",permalink:"/api/interfaces/ContainerInfo"}},t={},a=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Source",id:"source",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Source",id:"source-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Source",id:"source-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3115",children:"packages/extension-api/src/extension-api.d.ts:3115"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpus",children:"cpus?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"number of CPUs available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3111",children:"packages/extension-api/src/extension-api.d.ts:3111"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"disksize",children:"diskSize?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"diskSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space available for the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"diskused",children:"diskUsed?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"diskUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"unique id identifying the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3099",children:"packages/extension-api/src/extension-api.d.ts:3099"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"name of the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3103",children:"packages/extension-api/src/extension-api.d.ts:3103"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineType"}),": ",(0,s.jsx)(n.code,{children:'"docker"'})," | ",(0,s.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"engine type, either 'podman' or 'docker'"}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3107",children:"packages/extension-api/src/extension-api.d.ts:3107"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3119",children:"packages/extension-api/src/extension-api.d.ts:3119"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryused",children:"memoryUsed?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"memoryUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L3123",children:"packages/extension-api/src/extension-api.d.ts:3123"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>d,a:()=>c});var s=i(27378);const r={},o=s.createContext(r);function c(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{97294:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var s=i(24246),c=i(71670);const r={},o="Interface: ContainerEngineInfo",t={id:"interfaces/ContainerEngineInfo",title:"Interface: ContainerEngineInfo",description:"Resources information about a container engine",source:"@site/api/interfaces/ContainerEngineInfo.md",sourceDirName:"interfaces",slug:"/interfaces/ContainerEngineInfo",permalink:"/api/interfaces/ContainerEngineInfo",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"ContainerCreateResult",permalink:"/api/interfaces/ContainerCreateResult"},next:{title:"ContainerInfo",permalink:"/api/interfaces/ContainerInfo"}},d={},a=[{value:"Properties",id:"properties",level:2},{value:"cpuIdle?",id:"cpuidle",level:3},{value:"Source",id:"source",level:4},{value:"cpus?",id:"cpus",level:3},{value:"Source",id:"source-1",level:4},{value:"diskSize?",id:"disksize",level:3},{value:"Source",id:"source-2",level:4},{value:"diskUsed?",id:"diskused",level:3},{value:"Source",id:"source-3",level:4},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source-4",level:4},{value:"engineName",id:"enginename",level:3},{value:"Source",id:"source-5",level:4},{value:"engineType",id:"enginetype",level:3},{value:"Source",id:"source-6",level:4},{value:"memory?",id:"memory",level:3},{value:"Source",id:"source-7",level:4},{value:"memoryUsed?",id:"memoryused",level:3},{value:"Source",id:"source-8",level:4}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",...(0,c.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-containerengineinfo",children:"Interface: ContainerEngineInfo"}),"\n",(0,s.jsx)(n.p,{children:"Resources information about a container engine"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"cpuidle",children:"cpuIdle?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpuIdle"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Percentage of idle CPUs (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3115",children:"packages/extension-api/src/extension-api.d.ts:3115"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"cpus",children:"cpus?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"cpus"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"number of CPUs available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-1",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3111",children:"packages/extension-api/src/extension-api.d.ts:3111"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"disksize",children:"diskSize?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"diskSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space available for the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3127",children:"packages/extension-api/src/extension-api.d.ts:3127"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"diskused",children:"diskUsed?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"diskUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of disk space used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-3",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineId"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"unique id identifying the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-4",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3099",children:"packages/extension-api/src/extension-api.d.ts:3099"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineName"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"name of the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-5",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3103",children:"packages/extension-api/src/extension-api.d.ts:3103"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"engineType"}),": ",(0,s.jsx)(n.code,{children:'"docker"'})," | ",(0,s.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"engine type, either 'podman' or 'docker'"}),"\n",(0,s.jsx)(n.h4,{id:"source-6",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3107",children:"packages/extension-api/src/extension-api.d.ts:3107"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memory",children:"memory?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"memory"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory available for the container engine"}),"\n",(0,s.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3119",children:"packages/extension-api/src/extension-api.d.ts:3119"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"memoryused",children:"memoryUsed?"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"optional"})," ",(0,s.jsx)(n.strong,{children:"memoryUsed"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Quantity of memory used by the container engine (for Podman engines only)"}),"\n",(0,s.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L3123",children:"packages/extension-api/src/extension-api.d.ts:3123"})})]})}function h(e={}){const{wrapper:n}={...(0,c.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>t,a:()=>o});var s=i(27378);const c={},r=s.createContext(c);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ff2f63f6.a8c61899.js b/assets/js/ff2f63f6.fa868980.js similarity index 95% rename from assets/js/ff2f63f6.a8c61899.js rename to assets/js/ff2f63f6.fa868980.js index d112c8b8067..f9262f7d7db 100644 --- a/assets/js/ff2f63f6.a8c61899.js +++ b/assets/js/ff2f63f6.fa868980.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{53251:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var r=n(24246),a=n(71670);const s={},c="Interface: SecretStorageChangeEvent",o={id:"interfaces/SecretStorageChangeEvent",title:"Interface: SecretStorageChangeEvent",description:"The event data that is fired when a secret is added or removed.",source:"@site/api/interfaces/SecretStorageChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SecretStorage",permalink:"/api/interfaces/SecretStorage"},next:{title:"StatusBarItem",permalink:"/api/interfaces/StatusBarItem"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Source",id:"source",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"readonly"})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/3924f8198386a0368d040dc6fba8c7f605b6d07f/packages/extension-api/src/extension-api.d.ts#L4240",children:"packages/extension-api/src/extension-api.d.ts:4240"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const a={},s=r.createContext(a);function c(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{53251:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var r=n(24246),a=n(71670);const s={},c="Interface: SecretStorageChangeEvent",o={id:"interfaces/SecretStorageChangeEvent",title:"Interface: SecretStorageChangeEvent",description:"The event data that is fired when a secret is added or removed.",source:"@site/api/interfaces/SecretStorageChangeEvent.md",sourceDirName:"interfaces",slug:"/interfaces/SecretStorageChangeEvent",permalink:"/api/interfaces/SecretStorageChangeEvent",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"SecretStorage",permalink:"/api/interfaces/SecretStorage"},next:{title:"StatusBarItem",permalink:"/api/interfaces/StatusBarItem"}},i={},d=[{value:"Properties",id:"properties",level:2},{value:"key",id:"key",level:3},{value:"Source",id:"source",level:4}];function h(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",strong:"strong",...(0,a.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"interface-secretstoragechangeevent",children:"Interface: SecretStorageChangeEvent"}),"\n",(0,r.jsx)(t.p,{children:"The event data that is fired when a secret is added or removed."}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(t.h3,{id:"key",children:"key"}),"\n",(0,r.jsxs)(t.blockquote,{children:["\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"readonly"})," ",(0,r.jsx)(t.strong,{children:"key"}),": ",(0,r.jsx)(t.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(t.p,{children:"The key of the secret that has changed."}),"\n",(0,r.jsx)(t.h4,{id:"source",children:"Source"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/containers/podman-desktop/blob/cfe4ed1f6b14c8f159ec827208f47b718ebeb6fe/packages/extension-api/src/extension-api.d.ts#L4240",children:"packages/extension-api/src/extension-api.d.ts:4240"})})]})}function l(e={}){const{wrapper:t}={...(0,a.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},71670:(e,t,n)=>{n.d(t,{Z:()=>o,a:()=>c});var r=n(27378);const a={},s=r.createContext(a);function c(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.cea7d876.js b/assets/js/runtime~main.5229df76.js similarity index 71% rename from assets/js/runtime~main.cea7d876.js rename to assets/js/runtime~main.5229df76.js index 09d384623e0..dee2383d9af 100644 --- a/assets/js/runtime~main.cea7d876.js +++ b/assets/js/runtime~main.5229df76.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,d,f,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={exports:{}};return b[e].call(c.exports,c,c.exports,t),c.exports}t.m=b,e=[],t.O=(a,c,d,f)=>{if(!c){var b=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,d,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&d&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(f,b),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({125:"814d49b7",523:"a0323d9f",648:"714e70d1",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1782:"97a89ac0",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2281:"920c2ac2",2353:"92d7df62",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3342:"d1c21237",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3918:"fba901c9",3978:"3784eb9f",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5240:"22de4147",5301:"c8450033",5414:"724f3974",5417:"5e8fbcdf",5477:"164937d2",5674:"5c0f0993",5697:"e35d7c3e",5886:"57dba496",5967:"55c1b4f8",6082:"3866940b",6098:"cb0f21df",6102:"8677f412",6125:"reactPlayerSoundCloud",6266:"a2c6f402",6639:"8ccdb99f",7337:"2914ac57",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",9055:"e7923b27",9443:"06a6c4c7",9973:"4213e5b1",10038:"bc873533",10048:"48c6d145",10114:"e665718d",10138:"6269f1c0",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",11077:"49d9416a",11161:"a4794f2e",11621:"ff910f15",11724:"5087625a",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14158:"32eeb95a",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",15749:"7513472c",15980:"a7456010",16311:"c25913f3",16467:"878aa0e7",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17345:"fbf753af",17708:"688ee267",17741:"7d88b63f",17914:"df7d80d2",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19038:"3647c991",19043:"473de3ed",19093:"0029a336",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22673:"cd7f1ed9",22928:"5bc61e33",23427:"bd80aa65",23632:"ad460803",23650:"f25476cb",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24498:"7bef3f04",24583:"7c110bd0",24726:"280646e4",24904:"9d887a11",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25383:"d593bd65",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26348:"c104141c",26557:"5e486140",26690:"4816649b",27104:"35dda5a2",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27268:"57a8015d",27294:"f24b41ff",27328:"423842d7",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",28813:"5fb93fc0",28831:"b423b05c",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29685:"fe93ca5e",29693:"123a454a",30060:"0547cb65",30466:"0e3a398f",30517:"d1040fb3",30744:"41756ce8",30821:"aba485c2",30901:"ae4a775b",31004:"c141421f",31512:"7fa133e1",32472:"65a10ffa",32963:"93e77213",33067:"62e21724",33113:"25003e4f",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",33629:"aba21aa0",33940:"fe716911",34322:"69c5f318",34479:"0c14b239",34505:"b15015e0",34617:"95366386",34770:"450c2e30",34771:"fa55603a",34869:"368f00b2",34884:"e1c8d71f",35137:"41b2e801",35281:"8cb0269b",35425:"b4df9b48",35572:"6774f806",35584:"b52d840d",36006:"79f18c88",36075:"86e64757",36248:"e3f28bf9",36424:"a3002291",36738:"f3c74015",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",37930:"16aba86e",38056:"905702d2",38134:"1515c895",38331:"ca8d81fc",38684:"815c93fd",38780:"f26f8f05",39613:"1fbe0675",39620:"b51a9aee",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41718:"ccd38cf3",41798:"bd65ec7e",41869:"c361d244",41902:"edcfca88",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43546:"57e01cd5",43871:"065365b3",44422:"416d4fcf",44619:"a9fa5b1f",44781:"12f1535e",45033:"9af13eab",45326:"af231220",45346:"7f0476bd",45708:"97d49594",45711:"5bfee675",45835:"7547d3bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47679:"83245ae6",47718:"6864e844",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50528:"b4147104",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53579:"157a5a42",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54774:"42b67a8e",55641:"742fdf65",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57138:"38a042e4",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57507:"a3a2f890",57549:"bdb8b81b",57694:"fd702dc7",57816:"26a81b34",57881:"2658ced2",58216:"874690d0",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59208:"36994c47",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",59875:"d7ed6ffb",59993:"3196985c",60203:"c6aad055",60334:"a3f8794a",60443:"3e66a570",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62325:"d1462701",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63332:"5fc5a8f9",63407:"b8ec852b",63652:"6e92edd9",63707:"8c6c72f9",63709:"e30a1726",63863:"f771dec1",64013:"01a85c17",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64660:"2ee3e841",64797:"e73dae49",64891:"a30c0d44",64924:"5eb5385f",65144:"1ee92283",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66386:"36dd8eb2",66464:"adcef0a2",66521:"014457dd",66976:"bd250d73",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67690:"030ccfd9",67966:"0dd9aaeb",68059:"ca165b51",68097:"ff2f63f6",68351:"f1e1eddd",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68974:"8a864d1e",69006:"a08dfa31",69584:"b8eb0fce",70225:"e1a2ab10",70534:"4b8121dd",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71625:"de311ed4",71796:"64134c03",71809:"c6adc754",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73163:"cd343213",73177:"fc923f19",73225:"58331f81",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74340:"2bb2c1cd",74961:"4c5becac",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75697:"b7746a44",75741:"f27eaf88",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76167:"eb1d872f",76192:"64bd32f2",76267:"94324b0e",76518:"9dd60997",76932:"aaabcfd8",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77683:"01821883",77989:"10aab13f",78161:"dfdb978a",78327:"360dc931",78514:"d651e2ee",79106:"d4840880",79268:"c8eb055e",79649:"5bc09a53",79836:"d735f5d6",80114:"f467caba",80161:"3f66023b",80196:"7cb46bc8",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80503:"788e94db",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",81145:"e84cabb0",81580:"fee0a0be",81900:"4c217c25",82144:"09788c0c",82163:"c813bd67",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83152:"33a21d7d",83672:"8785b74d",83870:"5df556a2",83973:"f523fb3f",84413:"fff8aeb8",84507:"6aa0b043",84513:"6763d4e0",84573:"f9fb4395",84667:"reactPlayerMixcloud",84889:"e1f507a6",84940:"c11c87f7",84960:"b3b7dd16",85210:"1949cc8d",85376:"c44aa824",85396:"38fdc10b",85632:"3f797343",85714:"0cab2b3a",85799:"f4271232",86112:"5b7d9ef2",86216:"reactPlayerTwitch",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89251:"b9287eb6",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92217:"d7fbbe43",92423:"7258860f",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",92965:"16c1eac1",93089:"a6aa9e1f",93401:"c2865a15",94331:"e38c422a",94368:"a94703ab",95921:"fbfd390f",96017:"6a1fe514",96120:"35300761",96504:"53a3e6dc",96514:"a826efc5",96987:"caddb1c0",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97393:"acecf23e",97524:"59a876ee",97767:"17612ae7",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99494:"93e05602",99924:"df203c0f"}[e]||e)+"."+{125:"573f5bd3",523:"562a43f2",648:"37eb94ea",745:"597852b8",822:"816f765c",886:"15598666",899:"3759a417",955:"98c608dd",1074:"57999786",1516:"aff96286",1782:"db3adf3f",1837:"d180daa0",1868:"986cc880",2193:"e0ae080f",2281:"846df7a5",2353:"371dd8c4",2866:"d0db90a8",2883:"9e014dcf",3102:"393370fa",3207:"06460fe8",3342:"d5c92fbb",3408:"7742d5cb",3537:"e27c1a94",3584:"edec704e",3667:"1fdaa45f",3745:"fa128bad",3879:"772bbb02",3918:"47ac17d7",3978:"0f62db80",3984:"403f7889",4004:"b3a02fb6",4117:"ec7a4a75",4220:"867fda2c",4459:"72e55476",4918:"22642899",4929:"22848387",5240:"d3a91d08",5301:"d4591d6d",5414:"c0e2876c",5417:"de1f9805",5477:"639bf952",5674:"45e8a218",5697:"e2f7ed9c",5886:"2430ba1d",5967:"7e2f0956",6082:"17c2b646",6098:"d52947d5",6102:"401f89c7",6125:"b843d475",6266:"88a88e82",6639:"ab189fcd",7337:"aee69147",7371:"01948478",7377:"cdb919bf",7809:"998e30b6",8039:"e0d10218",9055:"200dc5b1",9443:"da8d9101",9500:"8bb8cb2a",9928:"396a67db",9973:"df3f1309",10038:"a069487e",10048:"1e4b2920",10114:"473ea000",10138:"bf6a6b79",10261:"91ba2584",10347:"522378b8",10349:"7d28f7e4",10379:"15e42704",10449:"ae04e529",10485:"59c782f5",10579:"264e9921",10588:"c064fcf7",10787:"fe0665e9",11077:"6d97fa5b",11161:"f73aaf9c",11621:"dfb02744",11724:"0be29d98",11981:"8e0e5133",12121:"99398064",12323:"1e784e4c",12864:"5b3803e1",13239:"d479a701",13317:"d23925bd",13573:"30e1fa56",13751:"5e2d5a45",13826:"6a47b2ca",14026:"8bb61dd4",14069:"263ec6c5",14077:"5a8fc5de",14094:"5cb3fca4",14142:"a6c790df",14158:"9b7e5618",14499:"b28f62b0",14824:"a0709e0d",15150:"302fbb99",15554:"26922457",15749:"9a35961e",15980:"e1310600",16311:"bc66943f",16467:"0bd0db54",16696:"78d0fc54",16728:"276e1097",16855:"173f3736",17194:"507ce3e0",17285:"26400bea",17329:"6bff2a6d",17345:"480a8ffb",17708:"4453f4ff",17741:"d04a108b",17914:"9501b831",18315:"57e4ce2c",18518:"5e093455",18565:"deb193b1",18649:"a2a0cb33",18768:"142353e8",18880:"b2892be8",19038:"f2120e4d",19043:"c222b4d1",19093:"5ed6088f",19536:"c2a17831",19537:"196fb016",19841:"706b0bd3",20044:"578cefbf",20138:"b4e44632",20205:"2bb300be",20406:"1d0a8d0b",20873:"3bce8054",21046:"6ebae7c1",21181:"395ec18f",21360:"0bd6a47a",21364:"52348da3",21534:"a2c2f481",22182:"1510c5a7",22228:"cff8e12c",22673:"5a86edee",22928:"44e06d3d",23427:"07a29926",23632:"2e60b1f5",23650:"35209f79",23840:"12ea908e",23937:"faa47b1d",24260:"d24ab03f",24386:"a02b0b95",24498:"6ae745be",24583:"a32b6013",24726:"a55fd209",24904:"e1c626e0",25204:"b756188c",25211:"5ca64b57",25314:"e0a4c1ca",25383:"964042fe",25817:"7fe14c43",25821:"95b46187",26011:"55e8cd60",26070:"4d45da95",26348:"2d4076eb",26557:"984c4bbe",26690:"b88bad28",27104:"c5d8514a",27135:"1509dff2",27168:"feda580b",27177:"88484072",27268:"94a47880",27294:"b5724789",27328:"7e4ffadb",27910:"2d1ecb4d",27918:"91507bdc",28143:"df278463",28145:"094f174a",28263:"da652198",28437:"54f0e0b3",28682:"6ad612e8",28813:"38b8d238",28831:"72ad198f",28899:"89d61cf3",29112:"8c38cc39",29234:"699944b6",29579:"c9c98e87",29661:"a5daa9f7",29685:"f010ab46",29693:"16051de8",30060:"8c078732",30466:"ad507ffe",30517:"01b830ac",30744:"7e7b1952",30821:"d420b308",30901:"b4095719",31004:"76bb3dc4",31512:"326e2756",32472:"bdb04e3f",32963:"7fe83e28",33067:"7a9df391",33113:"2da8b004",33233:"bdf41c70",33279:"e247b041",33356:"a31ef43d",33629:"c5504259",33940:"01292867",34322:"d3e9af23",34479:"b781dbf6",34505:"11f995c4",34617:"7500e0ad",34670:"60f01632",34770:"a27a2744",34771:"b33f9220",34869:"cd568cdc",34884:"7ace300b",35137:"51c4ca2f",35281:"74a37461",35425:"91bceb78",35572:"985e86c4",35584:"57ad3503",35711:"f33aa64e",36006:"4f88da56",36075:"85231160",36166:"ae8d5da7",36248:"407bd79c",36274:"3999e913",36424:"91ac2aaf",36738:"84e2dd26",37073:"c9338352",37245:"12c69428",37437:"17f087f4",37573:"973515e0",37683:"74f90660",37698:"72bdfffb",37737:"5704e252",37836:"0c33e067",37918:"b99573a9",37930:"28727b19",38056:"15384b6d",38134:"b5f7936a",38331:"b88583c3",38684:"1f7d2691",38780:"51ed725b",39613:"b1f5a1cd",39620:"4148c4f8",40070:"806e0a69",40486:"7ea08a7b",40569:"b35b1e1a",40592:"6efe6f19",40683:"b373b852",40816:"fd9e3a14",41169:"b85b6e5a",41619:"9dcfd3a1",41644:"a760b6a3",41718:"fb6ebed0",41798:"badb7f4a",41869:"88531310",41902:"181ccbab",41976:"ff14b025",42205:"cd994c6a",42326:"0582f3e4",42423:"4aeade7a",43010:"57b0b164",43163:"787db4e9",43274:"9000e27d",43474:"5e669a8c",43546:"96e99ef0",43871:"63c19168",44366:"ac8e857d",44422:"3e0c5e2e",44619:"6f29da5e",44781:"0fd70a99",45033:"c5e91988",45326:"c0091348",45346:"7c3df3dd",45708:"827c54ed",45711:"351d4ae6",45760:"518ecc83",45835:"056772f4",46103:"fe43b600",46623:"639f113c",46738:"34249012",47389:"1842021b",47596:"23612a4e",47679:"137981e9",47718:"e875c5c4",47875:"35b6b333",48123:"715530bf",48176:"f2ac2d57",48215:"b747793e",48610:"7d00d14b",48901:"698dc297",48926:"30ff376a",49076:"08b0f314",49867:"ce548982",50528:"3abfa7c0",50649:"109ee86f",51051:"d899bb94",51171:"834d0188",51320:"e5f5ddde",51499:"4d5a0b38",51843:"84eaf400",51978:"18d659ef",52343:"62681153",52525:"727c5ca3",52535:"d672aace",52546:"04c929f6",52920:"cdcca7c0",52950:"f31923d6",53237:"725c6765",53273:"a10fbb17",53479:"fe52b881",53579:"e5799b0d",53604:"26257f77",53608:"ad9fef43",53691:"05ef8875",53800:"c8c041c2",54063:"de5ac8a0",54191:"8c190567",54194:"2795bdef",54373:"8399e9e2",54632:"9e907467",54774:"5e089350",54854:"1ff29b25",55641:"43bbec2c",55904:"1ad3183b",56805:"7613f36a",56843:"b2c9a51a",56870:"9526b584",57076:"e0be15c4",57138:"c1f8c7a7",57321:"79e943c4",57366:"30a8a88e",57368:"7f88e4fd",57507:"a7f0f529",57549:"0e5020ba",57694:"e350ee84",57816:"67448afc",57881:"a7f9e4d8",58216:"52f3811f",58262:"84773a6e",58673:"21d4c59a",58739:"82d5334e",58792:"e382d954",58800:"f7eae07c",58989:"b7ba0274",59081:"9067e20a",59208:"d2597689",59341:"e324817d",59671:"1fce19a0",59812:"747fd838",59860:"c600fc62",59875:"8b1688a0",59993:"4264fbd3",60203:"555a74ca",60334:"8e650d99",60443:"89bdfae4",60564:"6e3f00f6",60574:"46e2251c",60637:"ccd004ca",60810:"90b00f9c",61021:"1ced2fd9",61281:"014856ed",61305:"7f87fc6c",61425:"c63568f9",61573:"5a42d2be",61866:"f757bd1d",61896:"4c7314c3",62283:"a8a09072",62325:"4b765d3f",62789:"13ef664e",62871:"187f5bf6",63154:"72dbec3d",63190:"fc5d8cbf",63332:"2780b485",63407:"df1976cd",63652:"f4bb86c2",63707:"139d296a",63709:"49cb138d",63863:"8aefadb5",64013:"1f868628",64258:"98bf19a2",64315:"8710f06b",64389:"15a51811",64438:"75d9a05e",64439:"545b7965",64471:"d29dd4fe",64651:"83484b26",64660:"d56a40ab",64797:"119d0da8",64891:"c2230f3d",64924:"fc64ed6f",65144:"5e32c094",65191:"fe3c8be8",65248:"15726df6",65375:"570be34c",65619:"dd896984",65776:"6a605342",65909:"6f4a66dd",66e3:"c45f671a",66386:"eb734a90",66464:"cc79f157",66521:"9f7d80bb",66976:"4831f030",67363:"c4ba807c",67411:"ad75358f",67480:"27114010",67539:"844c2f49",67690:"3ea085b6",67966:"d68306f6",68059:"8ff4783c",68097:"a8c61899",68351:"9a6b2deb",68732:"41c11196",68811:"d792a32b",68888:"19f0621a",68974:"43a6edf7",69006:"0afb1a55",69584:"1b89060f",70225:"b2255b83",70335:"eb92c593",70534:"591638a7",70595:"5668b0ad",70633:"40a7c15b",70900:"5138b9c7",70985:"73f5f1a0",71625:"2db3fd9d",71796:"586274fc",71809:"eb86dadd",71874:"c56a785a",71970:"ab8d6370",72079:"11b76d64",72092:"3d52975e",72179:"13cac64c",72491:"0f5fbff6",72896:"770b956c",72931:"e342f6e4",72996:"307856a6",73163:"2bb72b58",73177:"a56c7545",73225:"cdcc2efc",73285:"07fe4c85",73313:"3477b0dc",73636:"4838f79e",73714:"c908d675",73743:"b8146bc5",73867:"b5970dda",74340:"9502b14e",74961:"d0817f64",74988:"2c75a852",75167:"0c7d2dc9",75208:"78e7e655",75247:"be5525a4",75273:"478f380e",75290:"97ece1e1",75542:"39c9d44f",75689:"d1c1c256",75697:"b3aadf6e",75741:"1dc56cbc",75862:"b2dd59bf",76091:"65e227f4",76158:"ea14e931",76167:"42596f7b",76192:"6987e39f",76267:"8be2a011",76518:"154ea2ff",76932:"35a658b1",77060:"4e2ee602",77319:"79596fd0",77401:"df894251",77683:"93437474",77989:"c24fe1cf",78161:"23ad5c2d",78327:"3b1b5d03",78514:"9d2f1d92",79106:"5a545afc",79268:"2e07e869",79649:"d63c2054",79836:"9d8e2e66",80114:"dc22d9e8",80161:"8c172c62",80196:"5a52dbf8",80299:"6c9cc63a",80325:"334f13a0",80355:"f973499e",80448:"492890ac",80503:"f22bed0e",80511:"ed06781d",80900:"cc0ec403",80945:"844fa081",80954:"31b9ff74",81145:"844e6b59",81580:"d4da6a09",81900:"3826c1e7",82144:"d1cee927",82163:"7eeca794",82388:"304cf9c2",82409:"55c18137",82424:"c44e7539",82451:"ebd7b23f",82667:"0fbfb1c4",83039:"ebeff3f5",83152:"d32438bd",83672:"5573d395",83870:"62b30085",83973:"f226a777",84413:"08365ee7",84507:"8ada3374",84513:"d5ac2f59",84573:"38bb0f53",84667:"ec612995",84889:"1fff59aa",84940:"7aedef41",84960:"5a298e87",85067:"511c9e62",85210:"85d5ba0b",85376:"eb70aa8e",85396:"289d1c9e",85632:"e95db70a",85714:"ffdf50f5",85799:"79af877b",86112:"7c8e56ed",86216:"42cf6854",86272:"f7d344ee",86335:"9407a25b",86477:"82dfec5c",86528:"f1903984",86661:"7aff94ec",86730:"ad9e2eb6",87213:"2a76274c",87430:"f97de055",87664:"0aa437ad",87759:"9ece723e",88055:"fef9a984",88089:"c4115619",88566:"92ac54e0",89127:"77dc02e4",89251:"62bcb562",89372:"7f3b946d",89472:"1624095c",89626:"72fe0ae6",89731:"c2ea0190",89799:"02cc3b48",89950:"7bc7e2f7",90051:"f693b684",90125:"06db59f6",90522:"23870609",90681:"af019513",91447:"03fc55d5",91721:"c7e34470",91893:"d97a8766",92217:"940c3f0f",92423:"ad4a1342",92514:"a8548250",92599:"ae2b1a86",92786:"46806224",92916:"8c36af0c",92955:"b0713076",92958:"e902e9b7",92965:"f28cb0f8",93041:"3bde6a31",93089:"1a1575c7",93401:"ec2a87b6",94331:"cb421252",94368:"cc4585f3",94875:"1f649e1a",95628:"42c1eef6",95921:"e841d180",96017:"96fbf35d",96120:"a5f864fb",96504:"f72a4b68",96514:"5a47d9bd",96987:"44436372",97159:"37700053",97227:"d2b3ed6c",97251:"7662e5fd",97393:"1bc09864",97524:"06bd30aa",97767:"1d76b44f",97920:"cc575f3c",97953:"175e63b9",98170:"4e1dd157",98327:"12f5691c",98532:"451ee39f",98960:"d4225910",99086:"983c6343",99124:"2fe14e2d",99494:"134f5a4e",99924:"f7f1c762",99964:"1414e8fb"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="docs:",t.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",t.gca=function(e){return e={17896441:"27918",25622900:"61896",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",75281220:"57366",91008145:"42423",91392348:"60637",95366386:"34617","814d49b7":"125",a0323d9f:"523","714e70d1":"648","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516","97a89ac0":"1782",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","920c2ac2":"2281","92d7df62":"2353",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207",d1c21237:"3342","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879",fba901c9:"3918","3784eb9f":"3978","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929","22de4147":"5240",c8450033:"5301","724f3974":"5414","5e8fbcdf":"5417","164937d2":"5477","5c0f0993":"5674",e35d7c3e:"5697","57dba496":"5886","55c1b4f8":"5967","3866940b":"6082",cb0f21df:"6098","8677f412":"6102",reactPlayerSoundCloud:"6125",a2c6f402:"6266","8ccdb99f":"6639","2914ac57":"7337","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",e7923b27:"9055","06a6c4c7":"9443","4213e5b1":"9973",bc873533:"10038","48c6d145":"10048",e665718d:"10114","6269f1c0":"10138",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588","49d9416a":"11077",a4794f2e:"11161",ff910f15:"11621","5087625a":"11724",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142","32eeb95a":"14158","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554","7513472c":"15749",a7456010:"15980",c25913f3:"16311","878aa0e7":"16467","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329",fbf753af:"17345","688ee267":"17708","7d88b63f":"17741",df7d80d2:"17914",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","3647c991":"19038","473de3ed":"19043","0029a336":"19093","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228",cd7f1ed9:"22673","5bc61e33":"22928",bd80aa65:"23427",ad460803:"23632",f25476cb:"23650","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","7bef3f04":"24498","7c110bd0":"24583","280646e4":"24726","9d887a11":"24904","33f367df":"25204",d496897e:"25211",ab69fe56:"25314",d593bd65:"25383","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011",c104141c:"26348","5e486140":"26557","4816649b":"26690","35dda5a2":"27104","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","57a8015d":"27268",f24b41ff:"27294","423842d7":"27328",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682","5fb93fc0":"28813",b423b05c:"28831",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661",fe93ca5e:"29685","123a454a":"29693","0547cb65":"30060","0e3a398f":"30466",d1040fb3:"30517","41756ce8":"30744",aba485c2:"30821",ae4a775b:"30901",c141421f:"31004","7fa133e1":"31512","65a10ffa":"32472","93e77213":"32963","62e21724":"33067","25003e4f":"33113","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",aba21aa0:"33629",fe716911:"33940","69c5f318":"34322","0c14b239":"34479",b15015e0:"34505","450c2e30":"34770",fa55603a:"34771","368f00b2":"34869",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075",e3f28bf9:"36248",a3002291:"36424",f3c74015:"36738","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","16aba86e":"37930","905702d2":"38056","1515c895":"38134",ca8d81fc:"38331","815c93fd":"38684",f26f8f05:"38780","1fbe0675":"39613",b51a9aee:"39620","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644",ccd38cf3:"41718",bd65ec7e:"41798",c361d244:"41869",edcfca88:"41902","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","065365b3":"43871","416d4fcf":"44422",a9fa5b1f:"44619","12f1535e":"44781","9af13eab":"45033",af231220:"45326","7f0476bd":"45346","97d49594":"45708","5bfee675":"45711","7547d3bb":"45835",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596","83245ae6":"47679","6864e844":"47718","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076",b4147104:"50528","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479","157a5a42":"53579",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","42b67a8e":"54774","742fdf65":"55641","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","38a042e4":"57138","92b08985":"57321","6e30ac7b":"57368",a3a2f890:"57507",bdb8b81b:"57549",fd702dc7:"57694","26a81b34":"57816","2658ced2":"57881","874690d0":"58216","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081","36994c47":"59208",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",d7ed6ffb:"59875","3196985c":"59993",c6aad055:"60203",a3f8794a:"60334","3e66a570":"60443","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",d1462701:"62325",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190","5fc5a8f9":"63332",b8ec852b:"63407","6e92edd9":"63652","8c6c72f9":"63707",e30a1726:"63709",f771dec1:"63863","01a85c17":"64013",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651","2ee3e841":"64660",e73dae49:"64797",a30c0d44:"64891","5eb5385f":"64924","1ee92283":"65144",d103759a:"65191","6101b3fc":"65248","97615df2":"65375",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000","36dd8eb2":"66386",adcef0a2:"66464","014457dd":"66521",bd250d73:"66976","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539","030ccfd9":"67690","0dd9aaeb":"67966",ca165b51:"68059",ff2f63f6:"68097",f1e1eddd:"68351","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888","8a864d1e":"68974",a08dfa31:"69006",b8eb0fce:"69584",e1a2ab10:"70225","4b8121dd":"70534","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985",de311ed4:"71625","64134c03":"71796",c6adc754:"71809",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",cd343213:"73163",fc923f19:"73177","58331f81":"73225",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","2bb2c1cd":"74340","4c5becac":"74961","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",b7746a44:"75697",f27eaf88:"75741",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158",eb1d872f:"76167","64bd32f2":"76192","94324b0e":"76267","9dd60997":"76518",aaabcfd8:"76932","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401","01821883":"77683","10aab13f":"77989",dfdb978a:"78161","360dc931":"78327",d651e2ee:"78514",d4840880:"79106",c8eb055e:"79268","5bc09a53":"79649",d735f5d6:"79836",f467caba:"80114","3f66023b":"80161","7cb46bc8":"80196","98ced590":"80325",b5b19789:"80355","49bee2be":"80448","788e94db":"80503",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954",e84cabb0:"81145",fee0a0be:"81580","4c217c25":"81900","09788c0c":"82144",c813bd67:"82163",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","33a21d7d":"83152","8785b74d":"83672","5df556a2":"83870",f523fb3f:"83973",fff8aeb8:"84413","6aa0b043":"84507","6763d4e0":"84513",f9fb4395:"84573",reactPlayerMixcloud:"84667",e1f507a6:"84889",c11c87f7:"84940",b3b7dd16:"84960","1949cc8d":"85210",c44aa824:"85376","38fdc10b":"85396","3f797343":"85632","0cab2b3a":"85714",f4271232:"85799","5b7d9ef2":"86112",reactPlayerTwitch:"86216","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566",b9287eb6:"89251","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",d7fbbe43:"92217","7258860f":"92423",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958","16c1eac1":"92965",a6aa9e1f:"93089",c2865a15:"93401",e38c422a:"94331",a94703ab:"94368",fbfd390f:"95921","6a1fe514":"96017","53a3e6dc":"96504",a826efc5:"96514",caddb1c0:"96987",a8ce95ee:"97159",ba5b9f11:"97251",acecf23e:"97393","59a876ee":"97524","17612ae7":"97767","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124","93e05602":"99494",df203c0f:"99924"}[e]||e,t.p+t.u(e)},(()=>{var e={51303:0,40532:0};t.f.j=(a,c)=>{var d=t.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(40532|51303)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,d[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(d in r)t.o(r,d)&&(t.m[d]=r[d]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,d,f,b={},r={};function t(e){var a=r[e];if(void 0!==a)return a.exports;var c=r[e]={exports:{}};return b[e].call(c.exports,c,c.exports,t),c.exports}t.m=b,e=[],t.O=(a,c,d,f)=>{if(!c){var b=1/0;for(n=0;n=f)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(r=!1,f0&&e[n-1][2]>f;n--)e[n]=e[n-1];e[n]=[c,d,f]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);t.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var r=2&d&&e;"object"==typeof r&&!~a.indexOf(r);r=c(r))Object.getOwnPropertyNames(r).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,t.d(f,b),f},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({125:"814d49b7",523:"a0323d9f",648:"714e70d1",745:"64abd3af",822:"a00af9f0",886:"7aa856d6",899:"b985118d",955:"39ae3791",1074:"9e8f4e9c",1516:"8abd0ba5",1782:"97a89ac0",1837:"dec87402",1868:"46b3c144",2193:"c5b2f0f9",2281:"920c2ac2",2353:"92d7df62",2866:"e064f6d4",2883:"bb6a5560",3102:"3462068c",3207:"6603ef13",3342:"d1c21237",3408:"3ba80b69",3537:"3819c331",3584:"ed75cfcb",3667:"b6d76a6c",3745:"3109d9d2",3879:"2d629ea6",3918:"fba901c9",3978:"3784eb9f",3984:"160cb329",4004:"a334b453",4117:"fd684bd6",4220:"2bbe04e6",4459:"19eded63",4918:"24bda87b",4929:"330dfcdb",5240:"22de4147",5301:"c8450033",5414:"724f3974",5417:"5e8fbcdf",5477:"164937d2",5674:"5c0f0993",5697:"e35d7c3e",5886:"57dba496",5967:"55c1b4f8",6082:"3866940b",6098:"cb0f21df",6102:"8677f412",6125:"reactPlayerSoundCloud",6266:"a2c6f402",6639:"8ccdb99f",7337:"2914ac57",7371:"786fee93",7377:"708d858d",7809:"07305c4a",8039:"927c84a6",9055:"e7923b27",9443:"06a6c4c7",9973:"4213e5b1",10038:"bc873533",10048:"48c6d145",10114:"e665718d",10138:"6269f1c0",10261:"reactPlayerKaltura",10347:"bc816bf2",10379:"a943bcee",10485:"8873cf50",10579:"d46ef83d",10588:"7afa6340",11077:"49d9416a",11161:"a4794f2e",11621:"ff910f15",11724:"5087625a",11981:"b799648a",12121:"reactPlayerFacebook",12323:"6c80b6fe",12864:"e7477a94",13239:"bd45720e",13317:"d83f208d",13573:"be228752",13751:"3720c009",13826:"01a1d0f4",14026:"9c540f0b",14077:"40d377be",14142:"17d2ebc8",14158:"32eeb95a",14499:"73f18a6f",14824:"06a27da2",15150:"732d4d9b",15554:"1dfee34e",15749:"7513472c",15980:"a7456010",16311:"c25913f3",16467:"878aa0e7",16696:"6477cdc2",16728:"d9407a00",16855:"b7bb2d93",17194:"9f2f2cb3",17285:"c1ca9e21",17329:"04a546a4",17345:"fbf753af",17708:"688ee267",17741:"7d88b63f",17914:"df7d80d2",18518:"a7bd4aaa",18649:"49a2e93c",18768:"524ce9a0",18880:"deccabf3",19038:"3647c991",19043:"473de3ed",19093:"0029a336",19536:"0e72c11a",19537:"c1584a80",19841:"d9b4ee1e",20044:"d66cbd9e",20138:"54590fd2",20205:"2340b3ee",20406:"67386898",20873:"cabda5f8",21046:"4cb6c19a",21181:"ea3ffc82",21360:"9286a297",21364:"f7c9e078",21534:"8ae04122",22182:"f1ad83b2",22228:"125d93c1",22673:"cd7f1ed9",22928:"5bc61e33",23427:"bd80aa65",23632:"ad460803",23650:"f25476cb",23840:"562ca3e9",23937:"610f2c47",24260:"22e2140b",24386:"ae79aff5",24498:"7bef3f04",24583:"7c110bd0",24726:"280646e4",24904:"9d887a11",25204:"33f367df",25211:"d496897e",25314:"ab69fe56",25383:"d593bd65",25817:"70e3b13c",25821:"b9a87183",26011:"reactPlayerFilePlayer",26348:"c104141c",26557:"5e486140",26690:"4816649b",27104:"35dda5a2",27135:"5e30269e",27168:"4ec4c6cd",27177:"4f9e8711",27268:"57a8015d",27294:"f24b41ff",27328:"423842d7",27910:"c358ebbc",27918:"17896441",28143:"7e2ae3df",28145:"006e489c",28263:"82170cf7",28437:"5b10a003",28682:"8eeedb31",28813:"5fb93fc0",28831:"b423b05c",29112:"c09ab32f",29234:"86f8c256",29579:"09b168a7",29661:"5e95c892",29685:"fe93ca5e",29693:"123a454a",30060:"0547cb65",30466:"0e3a398f",30517:"d1040fb3",30744:"41756ce8",30821:"aba485c2",30901:"ae4a775b",31004:"c141421f",31512:"7fa133e1",32472:"65a10ffa",32963:"93e77213",33067:"62e21724",33113:"25003e4f",33233:"59a6f192",33279:"456c0e28",33356:"54d805e4",33629:"aba21aa0",33940:"fe716911",34322:"69c5f318",34479:"0c14b239",34505:"b15015e0",34617:"95366386",34770:"450c2e30",34771:"fa55603a",34869:"368f00b2",34884:"e1c8d71f",35137:"41b2e801",35281:"8cb0269b",35425:"b4df9b48",35572:"6774f806",35584:"b52d840d",36006:"79f18c88",36075:"86e64757",36248:"e3f28bf9",36424:"a3002291",36738:"f3c74015",37073:"0f54081d",37245:"b678a236",37437:"3d8d8999",37573:"48b6ff5f",37683:"df2a6e58",37698:"cd23aec9",37836:"7cde3c49",37918:"10ce918d",37930:"16aba86e",38056:"905702d2",38134:"1515c895",38331:"ca8d81fc",38684:"815c93fd",38780:"f26f8f05",39613:"1fbe0675",39620:"b51a9aee",40070:"86f2a982",40486:"ed2a4846",40569:"8519c2b0",40592:"b39cdcf9",40683:"3e2b82eb",40816:"4d71dffe",41169:"a2d1ff94",41619:"6494b798",41644:"9db962b6",41718:"ccd38cf3",41798:"bd65ec7e",41869:"c361d244",41902:"edcfca88",41976:"0c4fad6b",42205:"b66ca8cf",42326:"7b477840",42423:"91008145",43010:"56c3a9b2",43163:"232c546d",43274:"23a8e291",43474:"db22fd17",43546:"57e01cd5",43871:"065365b3",44422:"416d4fcf",44619:"a9fa5b1f",44781:"12f1535e",45033:"9af13eab",45326:"af231220",45346:"7f0476bd",45708:"97d49594",45711:"5bfee675",45835:"7547d3bb",46103:"ccc49370",46623:"b104dd1e",46738:"8dbb6800",47389:"612345e6",47596:"reactPlayerDailyMotion",47679:"83245ae6",47718:"6864e844",47875:"021eaa84",48123:"f86eb50f",48176:"5660752d",48215:"1cfced13",48610:"6875c492",48901:"640277b9",48926:"60c82955",49076:"494e8e75",49867:"44287967",50528:"b4147104",50649:"512fbd77",51051:"107d77e6",51171:"7e5a2776",51320:"46669adc",51499:"180d0c5f",51843:"a2ffcc0f",51978:"fe0d4a0f",52343:"97c7db18",52525:"1a906644",52535:"814f3328",52546:"reactPlayerStreamable",52920:"e0277333",52950:"67eba1be",53237:"1df93b7f",53273:"cc922df3",53479:"883e2c3c",53579:"157a5a42",53604:"cd7fa15a",53608:"9e4087bc",53691:"7be672a3",53800:"97eb992d",54063:"0fa6e9bf",54194:"1d31e443",54373:"b5114993",54632:"edb40f78",54774:"42b67a8e",55641:"742fdf65",55904:"931e3b0a",56805:"f7197f43",56843:"9f97f9d1",56870:"5a3b561f",57138:"38a042e4",57321:"92b08985",57366:"75281220",57368:"6e30ac7b",57507:"a3a2f890",57549:"bdb8b81b",57694:"fd702dc7",57816:"26a81b34",57881:"2658ced2",58216:"874690d0",58262:"059d1c6a",58673:"d9673b17",58739:"7a957b04",58792:"5db8318c",58800:"e6fb1369",58989:"d4bf7e47",59081:"5a7aef43",59208:"36994c47",59341:"a35cf155",59671:"0e384e19",59860:"d1163e47",59875:"d7ed6ffb",59993:"3196985c",60203:"c6aad055",60334:"a3f8794a",60443:"3e66a570",60564:"8b4ba22f",60574:"14ae68e7",60637:"91392348",60810:"254d0ff5",61021:"901c37e5",61281:"e983a6d7",61305:"73f9658e",61425:"fc8a94e3",61573:"87a5fc8a",61866:"1369aff7",61896:"25622900",62283:"74b658de",62325:"d1462701",62789:"c239db97",62871:"604e05e4",63154:"c6346fcf",63190:"e546fc5a",63332:"5fc5a8f9",63407:"b8ec852b",63652:"6e92edd9",63707:"8c6c72f9",63709:"e30a1726",63863:"f771dec1",64013:"01a85c17",64258:"reactPlayerMux",64315:"16914cba",64389:"d739767a",64438:"f20efc55",64439:"reactPlayerYouTube",64471:"cfdfe126",64651:"94f3d131",64660:"2ee3e841",64797:"e73dae49",64891:"a30c0d44",64924:"5eb5385f",65144:"1ee92283",65191:"d103759a",65248:"6101b3fc",65375:"97615df2",65619:"f6cf66bc",65776:"f0e3a130",66e3:"95646edb",66386:"36dd8eb2",66464:"adcef0a2",66521:"014457dd",66976:"bd250d73",67363:"583db3ef",67411:"b15eeff9",67480:"eb17771c",67539:"5c25e6fa",67690:"030ccfd9",67966:"0dd9aaeb",68059:"ca165b51",68097:"ff2f63f6",68351:"f1e1eddd",68732:"3132913e",68811:"3289a752",68888:"reactPlayerVidyard",68974:"8a864d1e",69006:"a08dfa31",69584:"b8eb0fce",70225:"e1a2ab10",70534:"4b8121dd",70595:"24dadce3",70633:"1fc83a28",70900:"fe1a05e2",70985:"814402d7",71625:"de311ed4",71796:"64134c03",71809:"c6adc754",71874:"cc6d9416",71970:"adfdec4a",72079:"1a16e8bf",72092:"148448cb",72179:"34767260",72491:"c71cae97",72896:"abc85917",72931:"e6c31e60",72996:"7a21ccb0",73163:"cd343213",73177:"fc923f19",73225:"58331f81",73285:"ed603d23",73636:"8b4dd820",73714:"894e67a6",73743:"reactPlayerVimeo",73867:"c7cac05f",74340:"2bb2c1cd",74961:"4c5becac",75167:"5046ea8f",75208:"f6cd0d3d",75247:"3c39daba",75273:"e69dadab",75290:"bf11c6a2",75542:"0102eb3e",75689:"c544b2d7",75697:"b7746a44",75741:"f27eaf88",75862:"ada86621",76091:"19e69ccd",76158:"51e516cc",76167:"eb1d872f",76192:"64bd32f2",76267:"94324b0e",76518:"9dd60997",76932:"aaabcfd8",77060:"7c7a772e",77319:"67fccd64",77401:"ca1234c1",77683:"01821883",77989:"10aab13f",78161:"dfdb978a",78327:"360dc931",78514:"d651e2ee",79106:"d4840880",79268:"c8eb055e",79649:"5bc09a53",79836:"d735f5d6",80114:"f467caba",80161:"3f66023b",80196:"7cb46bc8",80325:"98ced590",80355:"b5b19789",80448:"49bee2be",80503:"788e94db",80511:"fb8cd692",80900:"4ec76dfa",80945:"df322e14",80954:"8c8ef21f",81145:"e84cabb0",81580:"fee0a0be",81900:"4c217c25",82144:"09788c0c",82163:"c813bd67",82388:"bbf561d5",82409:"df4d464e",82424:"b6be2912",82451:"fb50ea3a",82667:"368cce37",83039:"825ec378",83152:"33a21d7d",83672:"8785b74d",83870:"5df556a2",83973:"f523fb3f",84413:"fff8aeb8",84507:"6aa0b043",84513:"6763d4e0",84573:"f9fb4395",84667:"reactPlayerMixcloud",84889:"e1f507a6",84940:"c11c87f7",84960:"b3b7dd16",85210:"1949cc8d",85376:"c44aa824",85396:"38fdc10b",85632:"3f797343",85714:"0cab2b3a",85799:"f4271232",86112:"5b7d9ef2",86216:"reactPlayerTwitch",86272:"7500e360",86335:"271ff0d1",86477:"a38d285e",86528:"2cb13d6d",86661:"43be69c9",87213:"0877aebd",87664:"reactPlayerPreview",87759:"ff38b1ce",88055:"reactPlayerWistia",88089:"6eafe0c7",88566:"9dce5486",89251:"b9287eb6",89372:"07f59c2a",89472:"5a9a7a02",89626:"81e486a8",89731:"9d2d4743",89799:"4f425ff4",89950:"12eb386e",90051:"185c52e7",90125:"7d9edfb8",90522:"308aae28",90681:"cdf64ea9",91447:"4974f5d2",91721:"3a38a610",91893:"871ce139",92217:"d7fbbe43",92423:"7258860f",92514:"b5ec5208",92599:"e44de27e",92786:"81b69ac7",92916:"91fe1403",92955:"e6412603",92958:"86063cd3",92965:"16c1eac1",93089:"a6aa9e1f",93401:"c2865a15",94331:"e38c422a",94368:"a94703ab",95921:"fbfd390f",96017:"6a1fe514",96120:"35300761",96504:"53a3e6dc",96514:"a826efc5",96987:"caddb1c0",97159:"a8ce95ee",97227:"71748509",97251:"ba5b9f11",97393:"acecf23e",97524:"59a876ee",97767:"17612ae7",97920:"1a4e3797",97953:"e88443f3",98170:"bab44fba",98532:"d1b15a6d",98960:"6bf124c2",99124:"dc23cd40",99494:"93e05602",99924:"df203c0f"}[e]||e)+"."+{125:"40814d6c",523:"562a43f2",648:"1260bd22",745:"597852b8",822:"816f765c",886:"0ad974c1",899:"3759a417",955:"ea84cf90",1074:"57999786",1516:"18235943",1782:"db3adf3f",1837:"79d0b788",1868:"854079d3",2193:"e0ae080f",2281:"522a5ee0",2353:"f2c2a891",2866:"1d93c541",2883:"9071d74c",3102:"393370fa",3207:"06460fe8",3342:"d5c92fbb",3408:"2a8ce54c",3537:"e27c1a94",3584:"edec704e",3667:"e17b76d0",3745:"ed797d7d",3879:"772bbb02",3918:"47ac17d7",3978:"0f62db80",3984:"5d4d4827",4004:"07a4e4c2",4117:"ec7a4a75",4220:"867fda2c",4459:"72e55476",4918:"22642899",4929:"22848387",5240:"d3a91d08",5301:"d4591d6d",5414:"c0e2876c",5417:"e9a40a25",5477:"e76ebb0f",5674:"7901905e",5697:"3e09c0dd",5886:"2c5fd896",5967:"7e2f0956",6082:"01d0b3bc",6098:"2794e421",6102:"401f89c7",6125:"b843d475",6266:"7387de79",6639:"bcd68439",7337:"aee69147",7371:"d2256763",7377:"cdb919bf",7809:"998e30b6",8039:"890d74f9",9055:"b0caf232",9443:"da8d9101",9500:"8bb8cb2a",9928:"396a67db",9973:"df3f1309",10038:"a069487e",10048:"1e4b2920",10114:"473ea000",10138:"bf6a6b79",10261:"91ba2584",10347:"522378b8",10349:"7d28f7e4",10379:"15e42704",10449:"ae04e529",10485:"59c782f5",10579:"137b9d8f",10588:"c064fcf7",10787:"fe0665e9",11077:"c53a1450",11161:"b6359376",11621:"dfb02744",11724:"0be29d98",11981:"8e0e5133",12121:"99398064",12323:"1e784e4c",12864:"f2a6c910",13239:"5a59fcfb",13317:"5df760c7",13573:"6b0bc52a",13751:"5e2d5a45",13826:"9ddc3e8f",14026:"e11b6540",14069:"263ec6c5",14077:"37712df2",14094:"5cb3fca4",14142:"9af76bf5",14158:"9b7e5618",14499:"ed8ddb43",14824:"70f42b7e",15150:"302fbb99",15554:"820d13fd",15749:"9a35961e",15980:"e1310600",16311:"7bc9c833",16467:"dcc083a2",16696:"98b636f6",16728:"46b475b3",16855:"3690e23f",17194:"507ce3e0",17285:"d79fcc4e",17329:"dd5b95ce",17345:"480a8ffb",17708:"3e358e5d",17741:"d04a108b",17914:"9501b831",18315:"57e4ce2c",18518:"5e093455",18565:"deb193b1",18649:"a2a0cb33",18768:"142353e8",18880:"1422a508",19038:"f2120e4d",19043:"c222b4d1",19093:"37c6ca63",19536:"60904b68",19537:"5384d5ed",19841:"9c832e54",20044:"04d75988",20138:"b4e44632",20205:"a32ba344",20406:"ed23d11a",20873:"3bce8054",21046:"6ebae7c1",21181:"81c1c214",21360:"6a29fab3",21364:"8efd229e",21534:"a2c2f481",22182:"cf54f055",22228:"b2e32dad",22673:"5a86edee",22928:"44e06d3d",23427:"07a29926",23632:"2e60b1f5",23650:"35209f79",23840:"12ea908e",23937:"ade9037d",24260:"8a237951",24386:"a02b0b95",24498:"6c143225",24583:"a32b6013",24726:"b135c66c",24904:"b65da091",25204:"b756188c",25211:"9b4c8363",25314:"9dc7f07d",25383:"964042fe",25817:"1bb1b752",25821:"62676c9b",26011:"55e8cd60",26070:"4d45da95",26348:"82632b0e",26557:"99524307",26690:"b88bad28",27104:"c5d8514a",27135:"3f855c2a",27168:"feda580b",27177:"692f7279",27268:"ce32507b",27294:"b5724789",27328:"5fe5a772",27910:"5aeedefe",27918:"91507bdc",28143:"005331b5",28145:"094f174a",28263:"5444f2e9",28437:"917f04f5",28682:"f1f917bf",28813:"38b8d238",28831:"72ad198f",28899:"89d61cf3",29112:"5013c25c",29234:"b8937dcb",29579:"c9c98e87",29661:"a5daa9f7",29685:"f010ab46",29693:"4a51b70f",30060:"41c1dd1f",30466:"636f207f",30517:"01b830ac",30744:"7e7b1952",30821:"d420b308",30901:"9903705b",31004:"76bb3dc4",31512:"80e21af8",32472:"bdb04e3f",32963:"7fe83e28",33067:"36eeec1f",33113:"2da8b004",33233:"bdf41c70",33279:"9cd2ca6b",33356:"b28214cc",33629:"c5504259",33940:"876d6afb",34322:"d3e9af23",34479:"bddcfa60",34505:"11f995c4",34617:"7500e0ad",34670:"60f01632",34770:"a27a2744",34771:"b33f9220",34869:"cd568cdc",34884:"854c1bab",35137:"a9f2ea71",35281:"b14e842c",35425:"8dc64818",35572:"6577b090",35584:"6ab58abf",35711:"f33aa64e",36006:"5ef384e8",36075:"44ad7428",36166:"ae8d5da7",36248:"e56187d1",36274:"3999e913",36424:"b486dcf8",36738:"84e2dd26",37073:"a43bded5",37245:"6573a0ea",37437:"17f087f4",37573:"973515e0",37683:"bf7fc67d",37698:"72bdfffb",37737:"5704e252",37836:"46bd4b2d",37918:"b99573a9",37930:"28727b19",38056:"9270b0a4",38134:"6df5ef78",38331:"b88583c3",38684:"1f7d2691",38780:"51ed725b",39613:"e090cfc3",39620:"e6e796d5",40070:"806e0a69",40486:"c041e84d",40569:"49d73a83",40592:"6efe6f19",40683:"a0f13645",40816:"fd9e3a14",41169:"26abb8a7",41619:"21a10cdc",41644:"ebf42e7b",41718:"fb6ebed0",41798:"29b762c8",41869:"88531310",41902:"025efc4b",41976:"f315177e",42205:"65dab99c",42326:"0582f3e4",42423:"6688c780",43010:"57b0b164",43163:"787db4e9",43274:"70fe0cbb",43474:"f1b1d125",43546:"0094c231",43871:"b2c7e967",44366:"ac8e857d",44422:"8158d7d1",44619:"0f426e7b",44781:"0fd70a99",45033:"c050981e",45326:"c0091348",45346:"e0aced37",45708:"d4ac0b5a",45711:"351d4ae6",45760:"518ecc83",45835:"60df8373",46103:"fe43b600",46623:"639f113c",46738:"a99cf824",47389:"344c2e2a",47596:"23612a4e",47679:"137981e9",47718:"e875c5c4",47875:"35b6b333",48123:"2df0e57b",48176:"f2ac2d57",48215:"b747793e",48610:"7d00d14b",48901:"392ed67f",48926:"428ff5b2",49076:"cf1e1680",49867:"f60e6b36",50528:"3abfa7c0",50649:"109ee86f",51051:"c9e7fa9f",51171:"8aca4f7e",51320:"35ac227c",51499:"de31f6e9",51843:"5504db9a",51978:"18d659ef",52343:"e0c15752",52525:"a6b73d9a",52535:"d672aace",52546:"04c929f6",52920:"cdcca7c0",52950:"f9d3c735",53237:"725c6765",53273:"71c3f7f0",53479:"fe18fe14",53579:"e5799b0d",53604:"26257f77",53608:"ad9fef43",53691:"05ef8875",53800:"c9efb1ea",54063:"621301e3",54191:"8c190567",54194:"2795bdef",54373:"02b996d6",54632:"80e11e37",54774:"de26eeaf",54854:"1ff29b25",55641:"43bbec2c",55904:"654442b9",56805:"104ca7ac",56843:"b2c9a51a",56870:"9526b584",57076:"e0be15c4",57138:"c1f8c7a7",57321:"05e88115",57366:"30a8a88e",57368:"b62145c6",57507:"a7f0f529",57549:"d23a92b8",57694:"07e2a99c",57816:"67448afc",57881:"a7f9e4d8",58216:"ddbbd135",58262:"84773a6e",58673:"476bf1b1",58739:"82d5334e",58792:"55e0ca8f",58800:"f7eae07c",58989:"b7ba0274",59081:"b2a3d131",59208:"d2597689",59341:"e324817d",59671:"1fce19a0",59812:"747fd838",59860:"581f856e",59875:"8b1688a0",59993:"4264fbd3",60203:"555a74ca",60334:"1542b189",60443:"89bdfae4",60564:"62df16df",60574:"5f714ab6",60637:"58eb5c18",60810:"5d9e482a",61021:"1ced2fd9",61281:"ba69138c",61305:"06ed5082",61425:"c63568f9",61573:"1e276eb5",61866:"f757bd1d",61896:"4c7314c3",62283:"12a2861b",62325:"4b765d3f",62789:"ce42ca48",62871:"1a891fa4",63154:"72dbec3d",63190:"039a4645",63332:"2780b485",63407:"a1ac7ee7",63652:"b367cc5c",63707:"b9da6a39",63709:"49cb138d",63863:"aaa1bd00",64013:"1f868628",64258:"98bf19a2",64315:"cf84919d",64389:"ee55486a",64438:"9778a34d",64439:"545b7965",64471:"b62b6dba",64651:"83484b26",64660:"d56a40ab",64797:"119d0da8",64891:"d7c6b3c1",64924:"fc64ed6f",65144:"60ab481f",65191:"07939a6c",65248:"15726df6",65375:"570be34c",65619:"a6dab972",65776:"6a605342",65909:"6f4a66dd",66e3:"ec266694",66386:"eb734a90",66464:"46f76829",66521:"9f7d80bb",66976:"4831f030",67363:"c4ba807c",67411:"ebc411c4",67480:"27114010",67539:"844c2f49",67690:"912df305",67966:"d68306f6",68059:"ddd888c4",68097:"fa868980",68351:"9a6b2deb",68732:"3644c321",68811:"d792a32b",68888:"19f0621a",68974:"6e435eff",69006:"515fb56d",69584:"f6979cd2",70225:"905d2fac",70335:"eb92c593",70534:"591638a7",70595:"711efd0e",70633:"826bbf44",70900:"77d044b4",70985:"a4ccc74d",71625:"2db3fd9d",71796:"587ee3ee",71809:"eb86dadd",71874:"aeb8f324",71970:"2b0d8ff3",72079:"11b76d64",72092:"94e20d50",72179:"13cac64c",72491:"0f5fbff6",72896:"770b956c",72931:"0e48bf3a",72996:"307856a6",73163:"2bb72b58",73177:"a8b94c1d",73225:"cdcc2efc",73285:"989866ed",73313:"3477b0dc",73636:"4838f79e",73714:"c908d675",73743:"b8146bc5",73867:"900be9d5",74340:"65f059e4",74961:"ce937a14",74988:"2c75a852",75167:"0ab713b7",75208:"9842885d",75247:"be5525a4",75273:"7e1ce040",75290:"a1773df7",75542:"b7e90bcb",75689:"bfdb33ab",75697:"b3aadf6e",75741:"84b8f89d",75862:"b2dd59bf",76091:"c21063ce",76158:"ea14e931",76167:"42596f7b",76192:"2f5c5bc7",76267:"d2561423",76518:"85ca45b0",76932:"35a658b1",77060:"6b1f0215",77319:"760428c5",77401:"a3a32778",77683:"f2780b48",77989:"c24fe1cf",78161:"23ad5c2d",78327:"3b1b5d03",78514:"9d2f1d92",79106:"5a545afc",79268:"2e07e869",79649:"74e17fca",79836:"9d8e2e66",80114:"dc22d9e8",80161:"cb3acf65",80196:"5a52dbf8",80299:"6c9cc63a",80325:"8b0d8b20",80355:"54301ca2",80448:"bbd0c7bc",80503:"f22bed0e",80511:"3d027e82",80900:"cc0ec403",80945:"844fa081",80954:"4b646b4d",81145:"044878ac",81580:"c074b613",81900:"747e67eb",82144:"d1cee927",82163:"3e01ddab",82388:"304cf9c2",82409:"841bfeb0",82424:"0b635538",82451:"ebd7b23f",82667:"0fbfb1c4",83039:"fc7bba51",83152:"d32438bd",83672:"c090ee62",83870:"62b30085",83973:"f226a777",84413:"08365ee7",84507:"7ef8ca39",84513:"ec4caa67",84573:"38bb0f53",84667:"ec612995",84889:"1fff59aa",84940:"7aedef41",84960:"a26b9658",85067:"511c9e62",85210:"85d5ba0b",85376:"eb70aa8e",85396:"289d1c9e",85632:"988030e3",85714:"836f2002",85799:"ce24c220",86112:"31b19207",86216:"42cf6854",86272:"262be0d8",86335:"5dd08dea",86477:"69fa8c7d",86528:"20130a1f",86661:"b3336065",86730:"ad9e2eb6",87213:"d8fd10e3",87430:"f97de055",87664:"0aa437ad",87759:"9ece723e",88055:"fef9a984",88089:"0842f474",88566:"92ac54e0",89127:"77dc02e4",89251:"9af2c247",89372:"7f3b946d",89472:"b6681f2a",89626:"72fe0ae6",89731:"5ec0c4d5",89799:"5ed6ed12",89950:"926ba567",90051:"a7b700dd",90125:"c775a4ff",90522:"23870609",90681:"f1566cd3",91447:"03fc55d5",91721:"058c912b",91893:"a79f0432",92217:"940c3f0f",92423:"95120d47",92514:"6742a5dc",92599:"ae2b1a86",92786:"43258e3d",92916:"f0d4cd64",92955:"51f44706",92958:"e902e9b7",92965:"f28cb0f8",93041:"3bde6a31",93089:"1a1575c7",93401:"b0cea802",94331:"ee333fbd",94368:"cc4585f3",94875:"1f649e1a",95628:"42c1eef6",95921:"fccd079a",96017:"f4ab80e3",96120:"fcfef048",96504:"f72a4b68",96514:"5a47d9bd",96987:"66d67b2b",97159:"37700053",97227:"26b7b045",97251:"7662e5fd",97393:"1bc09864",97524:"06bd30aa",97767:"48208848",97920:"cc575f3c",97953:"7df11f85",98170:"32f48154",98327:"12f5691c",98532:"451ee39f",98960:"d4225910",99086:"983c6343",99124:"1b419dea",99494:"134f5a4e",99924:"f7f1c762",99964:"1414e8fb"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="docs:",t.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var r,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{r.onerror=r.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],r.parentNode&&r.parentNode.removeChild(r),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:r}),12e4);r.onerror=u.bind(null,r.onerror),r.onload=u.bind(null,r.onload),o&&document.head.appendChild(r)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.p="/",t.gca=function(e){return e={17896441:"27918",25622900:"61896",34767260:"72179",35300761:"96120",44287967:"49867",67386898:"20406",71748509:"97227",75281220:"57366",91008145:"42423",91392348:"60637",95366386:"34617","814d49b7":"125",a0323d9f:"523","714e70d1":"648","64abd3af":"745",a00af9f0:"822","7aa856d6":"886",b985118d:"899","39ae3791":"955","9e8f4e9c":"1074","8abd0ba5":"1516","97a89ac0":"1782",dec87402:"1837","46b3c144":"1868",c5b2f0f9:"2193","920c2ac2":"2281","92d7df62":"2353",e064f6d4:"2866",bb6a5560:"2883","3462068c":"3102","6603ef13":"3207",d1c21237:"3342","3ba80b69":"3408","3819c331":"3537",ed75cfcb:"3584",b6d76a6c:"3667","3109d9d2":"3745","2d629ea6":"3879",fba901c9:"3918","3784eb9f":"3978","160cb329":"3984",a334b453:"4004",fd684bd6:"4117","2bbe04e6":"4220","19eded63":"4459","24bda87b":"4918","330dfcdb":"4929","22de4147":"5240",c8450033:"5301","724f3974":"5414","5e8fbcdf":"5417","164937d2":"5477","5c0f0993":"5674",e35d7c3e:"5697","57dba496":"5886","55c1b4f8":"5967","3866940b":"6082",cb0f21df:"6098","8677f412":"6102",reactPlayerSoundCloud:"6125",a2c6f402:"6266","8ccdb99f":"6639","2914ac57":"7337","786fee93":"7371","708d858d":"7377","07305c4a":"7809","927c84a6":"8039",e7923b27:"9055","06a6c4c7":"9443","4213e5b1":"9973",bc873533:"10038","48c6d145":"10048",e665718d:"10114","6269f1c0":"10138",reactPlayerKaltura:"10261",bc816bf2:"10347",a943bcee:"10379","8873cf50":"10485",d46ef83d:"10579","7afa6340":"10588","49d9416a":"11077",a4794f2e:"11161",ff910f15:"11621","5087625a":"11724",b799648a:"11981",reactPlayerFacebook:"12121","6c80b6fe":"12323",e7477a94:"12864",bd45720e:"13239",d83f208d:"13317",be228752:"13573","3720c009":"13751","01a1d0f4":"13826","9c540f0b":"14026","40d377be":"14077","17d2ebc8":"14142","32eeb95a":"14158","73f18a6f":"14499","06a27da2":"14824","732d4d9b":"15150","1dfee34e":"15554","7513472c":"15749",a7456010:"15980",c25913f3:"16311","878aa0e7":"16467","6477cdc2":"16696",d9407a00:"16728",b7bb2d93:"16855","9f2f2cb3":"17194",c1ca9e21:"17285","04a546a4":"17329",fbf753af:"17345","688ee267":"17708","7d88b63f":"17741",df7d80d2:"17914",a7bd4aaa:"18518","49a2e93c":"18649","524ce9a0":"18768",deccabf3:"18880","3647c991":"19038","473de3ed":"19043","0029a336":"19093","0e72c11a":"19536",c1584a80:"19537",d9b4ee1e:"19841",d66cbd9e:"20044","54590fd2":"20138","2340b3ee":"20205",cabda5f8:"20873","4cb6c19a":"21046",ea3ffc82:"21181","9286a297":"21360",f7c9e078:"21364","8ae04122":"21534",f1ad83b2:"22182","125d93c1":"22228",cd7f1ed9:"22673","5bc61e33":"22928",bd80aa65:"23427",ad460803:"23632",f25476cb:"23650","562ca3e9":"23840","610f2c47":"23937","22e2140b":"24260",ae79aff5:"24386","7bef3f04":"24498","7c110bd0":"24583","280646e4":"24726","9d887a11":"24904","33f367df":"25204",d496897e:"25211",ab69fe56:"25314",d593bd65:"25383","70e3b13c":"25817",b9a87183:"25821",reactPlayerFilePlayer:"26011",c104141c:"26348","5e486140":"26557","4816649b":"26690","35dda5a2":"27104","5e30269e":"27135","4ec4c6cd":"27168","4f9e8711":"27177","57a8015d":"27268",f24b41ff:"27294","423842d7":"27328",c358ebbc:"27910","7e2ae3df":"28143","006e489c":"28145","82170cf7":"28263","5b10a003":"28437","8eeedb31":"28682","5fb93fc0":"28813",b423b05c:"28831",c09ab32f:"29112","86f8c256":"29234","09b168a7":"29579","5e95c892":"29661",fe93ca5e:"29685","123a454a":"29693","0547cb65":"30060","0e3a398f":"30466",d1040fb3:"30517","41756ce8":"30744",aba485c2:"30821",ae4a775b:"30901",c141421f:"31004","7fa133e1":"31512","65a10ffa":"32472","93e77213":"32963","62e21724":"33067","25003e4f":"33113","59a6f192":"33233","456c0e28":"33279","54d805e4":"33356",aba21aa0:"33629",fe716911:"33940","69c5f318":"34322","0c14b239":"34479",b15015e0:"34505","450c2e30":"34770",fa55603a:"34771","368f00b2":"34869",e1c8d71f:"34884","41b2e801":"35137","8cb0269b":"35281",b4df9b48:"35425","6774f806":"35572",b52d840d:"35584","79f18c88":"36006","86e64757":"36075",e3f28bf9:"36248",a3002291:"36424",f3c74015:"36738","0f54081d":"37073",b678a236:"37245","3d8d8999":"37437","48b6ff5f":"37573",df2a6e58:"37683",cd23aec9:"37698","7cde3c49":"37836","10ce918d":"37918","16aba86e":"37930","905702d2":"38056","1515c895":"38134",ca8d81fc:"38331","815c93fd":"38684",f26f8f05:"38780","1fbe0675":"39613",b51a9aee:"39620","86f2a982":"40070",ed2a4846:"40486","8519c2b0":"40569",b39cdcf9:"40592","3e2b82eb":"40683","4d71dffe":"40816",a2d1ff94:"41169","6494b798":"41619","9db962b6":"41644",ccd38cf3:"41718",bd65ec7e:"41798",c361d244:"41869",edcfca88:"41902","0c4fad6b":"41976",b66ca8cf:"42205","7b477840":"42326","56c3a9b2":"43010","232c546d":"43163","23a8e291":"43274",db22fd17:"43474","57e01cd5":"43546","065365b3":"43871","416d4fcf":"44422",a9fa5b1f:"44619","12f1535e":"44781","9af13eab":"45033",af231220:"45326","7f0476bd":"45346","97d49594":"45708","5bfee675":"45711","7547d3bb":"45835",ccc49370:"46103",b104dd1e:"46623","8dbb6800":"46738","612345e6":"47389",reactPlayerDailyMotion:"47596","83245ae6":"47679","6864e844":"47718","021eaa84":"47875",f86eb50f:"48123","5660752d":"48176","1cfced13":"48215","6875c492":"48610","640277b9":"48901","60c82955":"48926","494e8e75":"49076",b4147104:"50528","512fbd77":"50649","107d77e6":"51051","7e5a2776":"51171","46669adc":"51320","180d0c5f":"51499",a2ffcc0f:"51843",fe0d4a0f:"51978","97c7db18":"52343","1a906644":"52525","814f3328":"52535",reactPlayerStreamable:"52546",e0277333:"52920","67eba1be":"52950","1df93b7f":"53237",cc922df3:"53273","883e2c3c":"53479","157a5a42":"53579",cd7fa15a:"53604","9e4087bc":"53608","7be672a3":"53691","97eb992d":"53800","0fa6e9bf":"54063","1d31e443":"54194",b5114993:"54373",edb40f78:"54632","42b67a8e":"54774","742fdf65":"55641","931e3b0a":"55904",f7197f43:"56805","9f97f9d1":"56843","5a3b561f":"56870","38a042e4":"57138","92b08985":"57321","6e30ac7b":"57368",a3a2f890:"57507",bdb8b81b:"57549",fd702dc7:"57694","26a81b34":"57816","2658ced2":"57881","874690d0":"58216","059d1c6a":"58262",d9673b17:"58673","7a957b04":"58739","5db8318c":"58792",e6fb1369:"58800",d4bf7e47:"58989","5a7aef43":"59081","36994c47":"59208",a35cf155:"59341","0e384e19":"59671",d1163e47:"59860",d7ed6ffb:"59875","3196985c":"59993",c6aad055:"60203",a3f8794a:"60334","3e66a570":"60443","8b4ba22f":"60564","14ae68e7":"60574","254d0ff5":"60810","901c37e5":"61021",e983a6d7:"61281","73f9658e":"61305",fc8a94e3:"61425","87a5fc8a":"61573","1369aff7":"61866","74b658de":"62283",d1462701:"62325",c239db97:"62789","604e05e4":"62871",c6346fcf:"63154",e546fc5a:"63190","5fc5a8f9":"63332",b8ec852b:"63407","6e92edd9":"63652","8c6c72f9":"63707",e30a1726:"63709",f771dec1:"63863","01a85c17":"64013",reactPlayerMux:"64258","16914cba":"64315",d739767a:"64389",f20efc55:"64438",reactPlayerYouTube:"64439",cfdfe126:"64471","94f3d131":"64651","2ee3e841":"64660",e73dae49:"64797",a30c0d44:"64891","5eb5385f":"64924","1ee92283":"65144",d103759a:"65191","6101b3fc":"65248","97615df2":"65375",f6cf66bc:"65619",f0e3a130:"65776","95646edb":"66000","36dd8eb2":"66386",adcef0a2:"66464","014457dd":"66521",bd250d73:"66976","583db3ef":"67363",b15eeff9:"67411",eb17771c:"67480","5c25e6fa":"67539","030ccfd9":"67690","0dd9aaeb":"67966",ca165b51:"68059",ff2f63f6:"68097",f1e1eddd:"68351","3132913e":"68732","3289a752":"68811",reactPlayerVidyard:"68888","8a864d1e":"68974",a08dfa31:"69006",b8eb0fce:"69584",e1a2ab10:"70225","4b8121dd":"70534","24dadce3":"70595","1fc83a28":"70633",fe1a05e2:"70900","814402d7":"70985",de311ed4:"71625","64134c03":"71796",c6adc754:"71809",cc6d9416:"71874",adfdec4a:"71970","1a16e8bf":"72079","148448cb":"72092",c71cae97:"72491",abc85917:"72896",e6c31e60:"72931","7a21ccb0":"72996",cd343213:"73163",fc923f19:"73177","58331f81":"73225",ed603d23:"73285","8b4dd820":"73636","894e67a6":"73714",reactPlayerVimeo:"73743",c7cac05f:"73867","2bb2c1cd":"74340","4c5becac":"74961","5046ea8f":"75167",f6cd0d3d:"75208","3c39daba":"75247",e69dadab:"75273",bf11c6a2:"75290","0102eb3e":"75542",c544b2d7:"75689",b7746a44:"75697",f27eaf88:"75741",ada86621:"75862","19e69ccd":"76091","51e516cc":"76158",eb1d872f:"76167","64bd32f2":"76192","94324b0e":"76267","9dd60997":"76518",aaabcfd8:"76932","7c7a772e":"77060","67fccd64":"77319",ca1234c1:"77401","01821883":"77683","10aab13f":"77989",dfdb978a:"78161","360dc931":"78327",d651e2ee:"78514",d4840880:"79106",c8eb055e:"79268","5bc09a53":"79649",d735f5d6:"79836",f467caba:"80114","3f66023b":"80161","7cb46bc8":"80196","98ced590":"80325",b5b19789:"80355","49bee2be":"80448","788e94db":"80503",fb8cd692:"80511","4ec76dfa":"80900",df322e14:"80945","8c8ef21f":"80954",e84cabb0:"81145",fee0a0be:"81580","4c217c25":"81900","09788c0c":"82144",c813bd67:"82163",bbf561d5:"82388",df4d464e:"82409",b6be2912:"82424",fb50ea3a:"82451","368cce37":"82667","825ec378":"83039","33a21d7d":"83152","8785b74d":"83672","5df556a2":"83870",f523fb3f:"83973",fff8aeb8:"84413","6aa0b043":"84507","6763d4e0":"84513",f9fb4395:"84573",reactPlayerMixcloud:"84667",e1f507a6:"84889",c11c87f7:"84940",b3b7dd16:"84960","1949cc8d":"85210",c44aa824:"85376","38fdc10b":"85396","3f797343":"85632","0cab2b3a":"85714",f4271232:"85799","5b7d9ef2":"86112",reactPlayerTwitch:"86216","7500e360":"86272","271ff0d1":"86335",a38d285e:"86477","2cb13d6d":"86528","43be69c9":"86661","0877aebd":"87213",reactPlayerPreview:"87664",ff38b1ce:"87759",reactPlayerWistia:"88055","6eafe0c7":"88089","9dce5486":"88566",b9287eb6:"89251","07f59c2a":"89372","5a9a7a02":"89472","81e486a8":"89626","9d2d4743":"89731","4f425ff4":"89799","12eb386e":"89950","185c52e7":"90051","7d9edfb8":"90125","308aae28":"90522",cdf64ea9:"90681","4974f5d2":"91447","3a38a610":"91721","871ce139":"91893",d7fbbe43:"92217","7258860f":"92423",b5ec5208:"92514",e44de27e:"92599","81b69ac7":"92786","91fe1403":"92916",e6412603:"92955","86063cd3":"92958","16c1eac1":"92965",a6aa9e1f:"93089",c2865a15:"93401",e38c422a:"94331",a94703ab:"94368",fbfd390f:"95921","6a1fe514":"96017","53a3e6dc":"96504",a826efc5:"96514",caddb1c0:"96987",a8ce95ee:"97159",ba5b9f11:"97251",acecf23e:"97393","59a876ee":"97524","17612ae7":"97767","1a4e3797":"97920",e88443f3:"97953",bab44fba:"98170",d1b15a6d:"98532","6bf124c2":"98960",dc23cd40:"99124","93e05602":"99494",df203c0f:"99924"}[e]||e,t.p+t.u(e)},(()=>{var e={51303:0,40532:0};t.f.j=(a,c)=>{var d=t.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(40532|51303)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=t.p+t.u(a),r=new Error;t.l(b,(c=>{if(t.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;r.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",r.name="ChunkLoadError",r.type=f,r.request=b,d[1](r)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],r=c[1],o=c[2],l=0;if(b.some((a=>0!==e[a]))){for(d in r)t.o(r,d)&&(t.m[d]=r[d]);if(o)var n=o(t)}for(a&&a(c);l - + diff --git a/blog/5-things-to-know-for-a-docker-user.html b/blog/5-things-to-know-for-a-docker-user.html index 15331026257..d8be31db971 100644 --- a/blog/5-things-to-know-for-a-docker-user.html +++ b/blog/5-things-to-know-for-a-docker-user.html @@ -13,7 +13,7 @@ - + diff --git a/blog/archive.html b/blog/archive.html index 8ab316a6796..264f9786560 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -13,7 +13,7 @@ - + diff --git a/blog/develop-using-devcontainer.html b/blog/develop-using-devcontainer.html index d040ee59b9a..257d49429e7 100644 --- a/blog/develop-using-devcontainer.html +++ b/blog/develop-using-devcontainer.html @@ -13,7 +13,7 @@ - + diff --git a/blog/getting-started-with-compose.html b/blog/getting-started-with-compose.html index ccf2ca7fcbe..493c45b7e0b 100644 --- a/blog/getting-started-with-compose.html +++ b/blog/getting-started-with-compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.10.html b/blog/podman-desktop-release-0.10.html index 47217e9b6a2..dd164f77df9 100644 --- a/blog/podman-desktop-release-0.10.html +++ b/blog/podman-desktop-release-0.10.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.11.html b/blog/podman-desktop-release-0.11.html index 0fd62b6badd..ee11b5f3427 100644 --- a/blog/podman-desktop-release-0.11.html +++ b/blog/podman-desktop-release-0.11.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.12.html b/blog/podman-desktop-release-0.12.html index 11eb912e6bc..bef2d0e56db 100644 --- a/blog/podman-desktop-release-0.12.html +++ b/blog/podman-desktop-release-0.12.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.13.html b/blog/podman-desktop-release-0.13.html index 964ad0f65ad..3eb92badb0c 100644 --- a/blog/podman-desktop-release-0.13.html +++ b/blog/podman-desktop-release-0.13.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.14.html b/blog/podman-desktop-release-0.14.html index 829e87064e7..8b53bc22b5b 100644 --- a/blog/podman-desktop-release-0.14.html +++ b/blog/podman-desktop-release-0.14.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-0.15.html b/blog/podman-desktop-release-0.15.html index 37dcf2ffca9..a03c064c39c 100644 --- a/blog/podman-desktop-release-0.15.html +++ b/blog/podman-desktop-release-0.15.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.0.html b/blog/podman-desktop-release-1.0.html index 85015ec6781..e1f44268389 100644 --- a/blog/podman-desktop-release-1.0.html +++ b/blog/podman-desktop-release-1.0.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.1.html b/blog/podman-desktop-release-1.1.html index 0d09cea04b5..bab4269afb8 100644 --- a/blog/podman-desktop-release-1.1.html +++ b/blog/podman-desktop-release-1.1.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.10.html b/blog/podman-desktop-release-1.10.html index 60cefe78369..988b27b255a 100644 --- a/blog/podman-desktop-release-1.10.html +++ b/blog/podman-desktop-release-1.10.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.2.html b/blog/podman-desktop-release-1.2.html index 339e8d4af7d..7c8e6b3b9a8 100644 --- a/blog/podman-desktop-release-1.2.html +++ b/blog/podman-desktop-release-1.2.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.3.html b/blog/podman-desktop-release-1.3.html index 13bc03284f2..8b781e9488f 100644 --- a/blog/podman-desktop-release-1.3.html +++ b/blog/podman-desktop-release-1.3.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.4.html b/blog/podman-desktop-release-1.4.html index 398c37e0fcc..ffcf24e5c01 100644 --- a/blog/podman-desktop-release-1.4.html +++ b/blog/podman-desktop-release-1.4.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.5.html b/blog/podman-desktop-release-1.5.html index 2188cc4f57b..c534d7cadb9 100644 --- a/blog/podman-desktop-release-1.5.html +++ b/blog/podman-desktop-release-1.5.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.6.html b/blog/podman-desktop-release-1.6.html index 6495fb3ceb2..3adf9c357b4 100644 --- a/blog/podman-desktop-release-1.6.html +++ b/blog/podman-desktop-release-1.6.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.7.html b/blog/podman-desktop-release-1.7.html index cd9f665814a..260063e524d 100644 --- a/blog/podman-desktop-release-1.7.html +++ b/blog/podman-desktop-release-1.7.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.8.html b/blog/podman-desktop-release-1.8.html index e761c20bb41..caad5cc8c2f 100644 --- a/blog/podman-desktop-release-1.8.html +++ b/blog/podman-desktop-release-1.8.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-release-1.9.html b/blog/podman-desktop-release-1.9.html index bddfaeda98b..f627536f325 100644 --- a/blog/podman-desktop-release-1.9.html +++ b/blog/podman-desktop-release-1.9.html @@ -13,7 +13,7 @@ - + diff --git a/blog/podman-desktop-wins-devies-award.html b/blog/podman-desktop-wins-devies-award.html index b4397bc56b5..e76334e5169 100644 --- a/blog/podman-desktop-wins-devies-award.html +++ b/blog/podman-desktop-wins-devies-award.html @@ -13,7 +13,7 @@ - + diff --git a/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html b/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html index 3d053db59c6..918666da9e1 100644 --- a/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html +++ b/blog/running-a-local-kubernetes-cluster-with-podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/blog/sharing-podman-images-with-kubernetes-cluster.html b/blog/sharing-podman-images-with-kubernetes-cluster.html index fa87ccad4a5..2750a464383 100644 --- a/blog/sharing-podman-images-with-kubernetes-cluster.html +++ b/blog/sharing-podman-images-with-kubernetes-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags.html b/blog/tags.html index af222056f22..d32f1b6a85f 100644 --- a/blog/tags.html +++ b/blog/tags.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/award.html b/blog/tags/award.html index 6ed3f460786..9ccfa5ecaba 100644 --- a/blog/tags/award.html +++ b/blog/tags/award.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/codespaces.html b/blog/tags/codespaces.html index 2066302d61b..50e26cefa07 100644 --- a/blog/tags/codespaces.html +++ b/blog/tags/codespaces.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/compose.html b/blog/tags/compose.html index 500d73c5f5b..4a24132cb4e 100644 --- a/blog/tags/compose.html +++ b/blog/tags/compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/containerfile.html b/blog/tags/containerfile.html index 050f7644356..40b17b5ae93 100644 --- a/blog/tags/containerfile.html +++ b/blog/tags/containerfile.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/containers.html b/blog/tags/containers.html index 2d971009e7e..abaa1d24bc9 100644 --- a/blog/tags/containers.html +++ b/blog/tags/containers.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/devcontainer.html b/blog/tags/devcontainer.html index b9b7bda0ce9..782fe02b162 100644 --- a/blog/tags/devcontainer.html +++ b/blog/tags/devcontainer.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/docker-compose.html b/blog/tags/docker-compose.html index add56a2634f..736faa45a2b 100644 --- a/blog/tags/docker-compose.html +++ b/blog/tags/docker-compose.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/docker.html b/blog/tags/docker.html index 1c3ddff08cc..0bff0b9d0f7 100644 --- a/blog/tags/docker.html +++ b/blog/tags/docker.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/dockerfile.html b/blog/tags/dockerfile.html index 3dd01c03e23..656b50f6c9f 100644 --- a/blog/tags/dockerfile.html +++ b/blog/tags/dockerfile.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/extensions.html b/blog/tags/extensions.html index 6309f78b141..5f5240164ec 100644 --- a/blog/tags/extensions.html +++ b/blog/tags/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/images.html b/blog/tags/images.html index d11b192a6b3..d2f4420878f 100644 --- a/blog/tags/images.html +++ b/blog/tags/images.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/kind.html b/blog/tags/kind.html index c7badeafdb1..ed67b0c53f6 100644 --- a/blog/tags/kind.html +++ b/blog/tags/kind.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/kubernetes.html b/blog/tags/kubernetes.html index f2dd099eabb..0eaac2b0582 100644 --- a/blog/tags/kubernetes.html +++ b/blog/tags/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/migrating.html b/blog/tags/migrating.html index 9c2c475046a..28d1e2f105d 100644 --- a/blog/tags/migrating.html +++ b/blog/tags/migrating.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/multi-container.html b/blog/tags/multi-container.html index ea30fac8a56..8d5aad1a08e 100644 --- a/blog/tags/multi-container.html +++ b/blog/tags/multi-container.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/onboarding.html b/blog/tags/onboarding.html index f77a9bc1668..da34bcd1aea 100644 --- a/blog/tags/onboarding.html +++ b/blog/tags/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/openshift.html b/blog/tags/openshift.html index 32bbb52ac58..bbd12e394e9 100644 --- a/blog/tags/openshift.html +++ b/blog/tags/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/podman-desktop.html b/blog/tags/podman-desktop.html index 45218990a64..32f23a791f0 100644 --- a/blog/tags/podman-desktop.html +++ b/blog/tags/podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/podman.html b/blog/tags/podman.html index 372a9bcf3e2..94b10f5a9a7 100644 --- a/blog/tags/podman.html +++ b/blog/tags/podman.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/release.html b/blog/tags/release.html index d28ef82c0db..a90ca94a730 100644 --- a/blog/tags/release.html +++ b/blog/tags/release.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/settings.html b/blog/tags/settings.html index edb454e01d4..4f5bc4e5bca 100644 --- a/blog/tags/settings.html +++ b/blog/tags/settings.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/story.html b/blog/tags/story.html index 6c85968166f..87a327db24f 100644 --- a/blog/tags/story.html +++ b/blog/tags/story.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/wasi.html b/blog/tags/wasi.html index 0c4920125a1..36f8cc39746 100644 --- a/blog/tags/wasi.html +++ b/blog/tags/wasi.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/wasm.html b/blog/tags/wasm.html index a7b4ae48f72..d702bd2f38b 100644 --- a/blog/tags/wasm.html +++ b/blog/tags/wasm.html @@ -13,7 +13,7 @@ - + diff --git a/blog/tags/web-assembly.html b/blog/tags/web-assembly.html index 09db61783fb..1fe8ba8f402 100644 --- a/blog/tags/web-assembly.html +++ b/blog/tags/web-assembly.html @@ -13,7 +13,7 @@ - + diff --git a/blog/wasm-workloads-on-macos-and-windows-with-podman.html b/blog/wasm-workloads-on-macos-and-windows-with-podman.html index d47cf6d50d9..5821b308d05 100644 --- a/blog/wasm-workloads-on-macos-and-windows-with-podman.html +++ b/blog/wasm-workloads-on-macos-and-windows-with-podman.html @@ -13,7 +13,7 @@ - + diff --git a/core-values.html b/core-values.html index 6bd96faadff..2cb04a7bee8 100644 --- a/core-values.html +++ b/core-values.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab.html b/docs/ai-lab.html index a93a5db4ef6..b603643b50a 100644 --- a/docs/ai-lab.html +++ b/docs/ai-lab.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/create-playground.html b/docs/ai-lab/create-playground.html index df92de056e2..e5d03e7981c 100644 --- a/docs/ai-lab/create-playground.html +++ b/docs/ai-lab/create-playground.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/download-model.html b/docs/ai-lab/download-model.html index ca160ab0594..10c2a5d1906 100644 --- a/docs/ai-lab/download-model.html +++ b/docs/ai-lab/download-model.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/installing.html b/docs/ai-lab/installing.html index 26e59256bde..2e4c35476cd 100644 --- a/docs/ai-lab/installing.html +++ b/docs/ai-lab/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/start-inference-server.html b/docs/ai-lab/start-inference-server.html index 670bab6fbda..b3a0c01bf37 100644 --- a/docs/ai-lab/start-inference-server.html +++ b/docs/ai-lab/start-inference-server.html @@ -13,7 +13,7 @@ - + diff --git a/docs/ai-lab/start-recipe.html b/docs/ai-lab/start-recipe.html index d7986e3b6dd..c4a7f04bc90 100644 --- a/docs/ai-lab/start-recipe.html +++ b/docs/ai-lab/start-recipe.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose.html b/docs/compose.html index 0c9e433af0f..6c884f0c8cf 100644 --- a/docs/compose.html +++ b/docs/compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/running-compose.html b/docs/compose/running-compose.html index 9440da0d03b..54c8e4ca811 100644 --- a/docs/compose/running-compose.html +++ b/docs/compose/running-compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/setting-up-compose.html b/docs/compose/setting-up-compose.html index 0d2ea1bd699..f1012bd6875 100644 --- a/docs/compose/setting-up-compose.html +++ b/docs/compose/setting-up-compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/compose/troubleshooting.html b/docs/compose/troubleshooting.html index 6c23028bc40..7d1431158b2 100644 --- a/docs/compose/troubleshooting.html +++ b/docs/compose/troubleshooting.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers.html b/docs/containers.html index dbe65abd8b1..d141ff5dffe 100644 --- a/docs/containers.html +++ b/docs/containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/creating-a-pod.html b/docs/containers/creating-a-pod.html index cbfdd156e99..786d1ea3b3c 100644 --- a/docs/containers/creating-a-pod.html +++ b/docs/containers/creating-a-pod.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images.html b/docs/containers/images.html index e83ee140bb4..f8117de0505 100644 --- a/docs/containers/images.html +++ b/docs/containers/images.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/building-an-image.html b/docs/containers/images/building-an-image.html index c490c389e2e..d3e507fe076 100644 --- a/docs/containers/images/building-an-image.html +++ b/docs/containers/images/building-an-image.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/pulling-an-image.html b/docs/containers/images/pulling-an-image.html index 0fbf5c5781e..0717d59c360 100644 --- a/docs/containers/images/pulling-an-image.html +++ b/docs/containers/images/pulling-an-image.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/images/pushing-an-image-to-a-registry.html b/docs/containers/images/pushing-an-image-to-a-registry.html index f86464d7a9a..13741013411 100644 --- a/docs/containers/images/pushing-an-image-to-a-registry.html +++ b/docs/containers/images/pushing-an-image-to-a-registry.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/onboarding.html b/docs/containers/onboarding.html index d94c4d43385..673085bd7c7 100644 --- a/docs/containers/onboarding.html +++ b/docs/containers/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/registries.html b/docs/containers/registries.html index 82099aec870..71f4af50005 100644 --- a/docs/containers/registries.html +++ b/docs/containers/registries.html @@ -13,7 +13,7 @@ - + diff --git a/docs/containers/starting-a-container.html b/docs/containers/starting-a-container.html index 3b3c843a4bd..2e0682b8237 100644 --- a/docs/containers/starting-a-container.html +++ b/docs/containers/starting-a-container.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions.html b/docs/extensions.html index 03761bc28c4..d1db2e2b6c0 100644 --- a/docs/extensions.html +++ b/docs/extensions.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/api.html b/docs/extensions/api.html index 3c363d70149..272d7148949 100644 --- a/docs/extensions/api.html +++ b/docs/extensions/api.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing.html b/docs/extensions/developing.html index d23c0e1b651..25698f2634e 100644 --- a/docs/extensions/developing.html +++ b/docs/extensions/developing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/adding-icons.html b/docs/extensions/developing/adding-icons.html index ac2d1bf8dfe..4b8f7978128 100644 --- a/docs/extensions/developing/adding-icons.html +++ b/docs/extensions/developing/adding-icons.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/onboarding-workflow.html b/docs/extensions/developing/onboarding-workflow.html index c3e9cd4cfcb..ddceef6acf7 100644 --- a/docs/extensions/developing/onboarding-workflow.html +++ b/docs/extensions/developing/onboarding-workflow.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/developing/when-clause-context.html b/docs/extensions/developing/when-clause-context.html index 3dd0cb3a0a2..2facc85ee1e 100644 --- a/docs/extensions/developing/when-clause-context.html +++ b/docs/extensions/developing/when-clause-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/install.html b/docs/extensions/install.html index 32a52327cb9..c246af48751 100644 --- a/docs/extensions/install.html +++ b/docs/extensions/install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/extensions/publish.html b/docs/extensions/publish.html index 5b59eda6794..320f4afb29c 100644 --- a/docs/extensions/publish.html +++ b/docs/extensions/publish.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation.html b/docs/installation.html index 98f6307b5f8..5676bb9fdb7 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/linux-install.html b/docs/installation/linux-install.html index 95a535bf44a..057c00c0342 100644 --- a/docs/installation/linux-install.html +++ b/docs/installation/linux-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html b/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html index c0a5d086008..7565e0ecde6 100644 --- a/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html +++ b/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/macos-install.html b/docs/installation/macos-install.html index 1759fd1150d..41f398a904f 100644 --- a/docs/installation/macos-install.html +++ b/docs/installation/macos-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/installation/windows-install.html b/docs/installation/windows-install.html index 5557dba6c2f..e197127264e 100644 --- a/docs/installation/windows-install.html +++ b/docs/installation/windows-install.html @@ -13,7 +13,7 @@ - + diff --git a/docs/intro.html b/docs/intro.html index c15ad6f7117..083943d07f5 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind.html b/docs/kind.html index 9fd8d073b47..eb8d2638509 100644 --- a/docs/kind.html +++ b/docs/kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/building-an-image-and-testing-it-in-kind.html b/docs/kind/building-an-image-and-testing-it-in-kind.html index 6ba76b5e587..3271b7f4d27 100644 --- a/docs/kind/building-an-image-and-testing-it-in-kind.html +++ b/docs/kind/building-an-image-and-testing-it-in-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/configuring-podman-for-kind-on-windows.html b/docs/kind/configuring-podman-for-kind-on-windows.html index 348022f638f..dd12ecc2a35 100644 --- a/docs/kind/configuring-podman-for-kind-on-windows.html +++ b/docs/kind/configuring-podman-for-kind-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/creating-a-kind-cluster.html b/docs/kind/creating-a-kind-cluster.html index a966c9f54bc..c1fbb7b258e 100644 --- a/docs/kind/creating-a-kind-cluster.html +++ b/docs/kind/creating-a-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/deleting-your-kind-cluster.html b/docs/kind/deleting-your-kind-cluster.html index 58ac799f160..848c50f9d90 100644 --- a/docs/kind/deleting-your-kind-cluster.html +++ b/docs/kind/deleting-your-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/installing.html b/docs/kind/installing.html index 6203f47b896..50592a7a31f 100644 --- a/docs/kind/installing.html +++ b/docs/kind/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/pushing-an-image-to-kind.html b/docs/kind/pushing-an-image-to-kind.html index f4920446817..069a63de287 100644 --- a/docs/kind/pushing-an-image-to-kind.html +++ b/docs/kind/pushing-an-image-to-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/restarting-your-kind-cluster.html b/docs/kind/restarting-your-kind-cluster.html index b1c2d22dfa4..acb0511d298 100644 --- a/docs/kind/restarting-your-kind-cluster.html +++ b/docs/kind/restarting-your-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kind/working-with-your-local-kind-cluster.html b/docs/kind/working-with-your-local-kind-cluster.html index 0c5430d5c74..697fdd897f6 100644 --- a/docs/kind/working-with-your-local-kind-cluster.html +++ b/docs/kind/working-with-your-local-kind-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes.html b/docs/kubernetes.html index 85ce7b09e93..e4cdfc047ce 100644 --- a/docs/kubernetes.html +++ b/docs/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/deploying-a-container-to-kubernetes.html b/docs/kubernetes/deploying-a-container-to-kubernetes.html index 4272dfa5112..2aa06c179bc 100644 --- a/docs/kubernetes/deploying-a-container-to-kubernetes.html +++ b/docs/kubernetes/deploying-a-container-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/deploying-a-pod-to-kubernetes.html b/docs/kubernetes/deploying-a-pod-to-kubernetes.html index 615561a704f..991e90ef31d 100644 --- a/docs/kubernetes/deploying-a-pod-to-kubernetes.html +++ b/docs/kubernetes/deploying-a-pod-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/existing-kubernetes.html b/docs/kubernetes/existing-kubernetes.html index 4109ef5153b..af194189c07 100644 --- a/docs/kubernetes/existing-kubernetes.html +++ b/docs/kubernetes/existing-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/kind/pushing-an-image-to-kind.html b/docs/kubernetes/kind/pushing-an-image-to-kind.html index 9941362b5a7..90d8be7ea57 100644 --- a/docs/kubernetes/kind/pushing-an-image-to-kind.html +++ b/docs/kubernetes/kind/pushing-an-image-to-kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/lima/pushing-an-image-to-lima.html b/docs/kubernetes/lima/pushing-an-image-to-lima.html index d33b938ec67..9e2165b2913 100644 --- a/docs/kubernetes/lima/pushing-an-image-to-lima.html +++ b/docs/kubernetes/lima/pushing-an-image-to-lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/minikube/pushing-an-image-to-minikube.html b/docs/kubernetes/minikube/pushing-an-image-to-minikube.html index a0dc2b5eefb..fdcbe9cb5fc 100644 --- a/docs/kubernetes/minikube/pushing-an-image-to-minikube.html +++ b/docs/kubernetes/minikube/pushing-an-image-to-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html b/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html index 2b29e5baa43..c646d5fe049 100644 --- a/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html +++ b/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.html @@ -13,7 +13,7 @@ - + diff --git a/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html b/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html index c69cdf8438f..deae62827fe 100644 --- a/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html +++ b/docs/kubernetes/viewing-and-selecting-current-kubernete-context.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima.html b/docs/lima.html index f695968d4ef..a90bd792924 100644 --- a/docs/lima.html +++ b/docs/lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/creating-a-kubernetes-instance.html b/docs/lima/creating-a-kubernetes-instance.html index f89a4408c28..a955277d619 100644 --- a/docs/lima/creating-a-kubernetes-instance.html +++ b/docs/lima/creating-a-kubernetes-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/creating-a-lima-instance.html b/docs/lima/creating-a-lima-instance.html index 94c5686328b..5aaa278451e 100644 --- a/docs/lima/creating-a-lima-instance.html +++ b/docs/lima/creating-a-lima-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/customizing.html b/docs/lima/customizing.html index c9b845d7e80..ec3dbef564f 100644 --- a/docs/lima/customizing.html +++ b/docs/lima/customizing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/lima/installing.html b/docs/lima/installing.html index ba3e65094d4..254fa97c334 100644 --- a/docs/lima/installing.html +++ b/docs/lima/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker.html b/docs/migrating-from-docker.html index 9971270576a..fae3cb32dd0 100644 --- a/docs/migrating-from-docker.html +++ b/docs/migrating-from-docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/emulating-docker-cli-with-podman.html b/docs/migrating-from-docker/emulating-docker-cli-with-podman.html index 9a2f15565d8..d14c02354c4 100644 --- a/docs/migrating-from-docker/emulating-docker-cli-with-podman.html +++ b/docs/migrating-from-docker/emulating-docker-cli-with-podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/importing-saved-containers.html b/docs/migrating-from-docker/importing-saved-containers.html index 75d69fee331..12d0961ba68 100644 --- a/docs/migrating-from-docker/importing-saved-containers.html +++ b/docs/migrating-from-docker/importing-saved-containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/using-podman-mac-helper.html b/docs/migrating-from-docker/using-podman-mac-helper.html index dbe1b394a5b..faa097fe8c3 100644 --- a/docs/migrating-from-docker/using-podman-mac-helper.html +++ b/docs/migrating-from-docker/using-podman-mac-helper.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/using-the-docker_host-environment-variable.html b/docs/migrating-from-docker/using-the-docker_host-environment-variable.html index 209e23bc559..72d0153ff21 100644 --- a/docs/migrating-from-docker/using-the-docker_host-environment-variable.html +++ b/docs/migrating-from-docker/using-the-docker_host-environment-variable.html @@ -13,7 +13,7 @@ - + diff --git a/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html b/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html index 16d4b933593..db1a2a5715c 100644 --- a/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html +++ b/docs/migrating-from-docker/verifying-your-tools-are-using-podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube.html b/docs/minikube.html index c35c6b3361b..e80db8f1441 100644 --- a/docs/minikube.html +++ b/docs/minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/building-an-image-and-testing-it-in-minikube.html b/docs/minikube/building-an-image-and-testing-it-in-minikube.html index 02c580a4487..b7ac6be0bb4 100644 --- a/docs/minikube/building-an-image-and-testing-it-in-minikube.html +++ b/docs/minikube/building-an-image-and-testing-it-in-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/configuring-podman-for-minikube-on-windows.html b/docs/minikube/configuring-podman-for-minikube-on-windows.html index 22429f54eab..83e97f661b1 100644 --- a/docs/minikube/configuring-podman-for-minikube-on-windows.html +++ b/docs/minikube/configuring-podman-for-minikube-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/creating-a-minikube-cluster.html b/docs/minikube/creating-a-minikube-cluster.html index 16af1cd048f..f06df29cfbe 100644 --- a/docs/minikube/creating-a-minikube-cluster.html +++ b/docs/minikube/creating-a-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/deleting-your-minikube-cluster.html b/docs/minikube/deleting-your-minikube-cluster.html index f39d4da4884..9f83201646a 100644 --- a/docs/minikube/deleting-your-minikube-cluster.html +++ b/docs/minikube/deleting-your-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/installing.html b/docs/minikube/installing.html index 67dfbd4672e..7d8367dd3ec 100644 --- a/docs/minikube/installing.html +++ b/docs/minikube/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/pushing-an-image-to-minikube.html b/docs/minikube/pushing-an-image-to-minikube.html index 47940ed24c3..b309bec1023 100644 --- a/docs/minikube/pushing-an-image-to-minikube.html +++ b/docs/minikube/pushing-an-image-to-minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/restarting-your-minikube-cluster.html b/docs/minikube/restarting-your-minikube-cluster.html index 330942aa9a8..fb7e4c7cedf 100644 --- a/docs/minikube/restarting-your-minikube-cluster.html +++ b/docs/minikube/restarting-your-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/minikube/working-with-your-local-minikube-cluster.html b/docs/minikube/working-with-your-local-minikube-cluster.html index aab10116f70..748d2fdbfc4 100644 --- a/docs/minikube/working-with-your-local-minikube-cluster.html +++ b/docs/minikube/working-with-your-local-minikube-cluster.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift.html b/docs/openshift.html index c5f8e236a27..cec4100d918 100644 --- a/docs/openshift.html +++ b/docs/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift/developer-sandbox.html b/docs/openshift/developer-sandbox.html index b3ddac7f45a..c92757567b7 100644 --- a/docs/openshift/developer-sandbox.html +++ b/docs/openshift/developer-sandbox.html @@ -13,7 +13,7 @@ - + diff --git a/docs/openshift/openshift-local.html b/docs/openshift/openshift-local.html index 09e697e91fa..ba1ff10503f 100644 --- a/docs/openshift/openshift-local.html +++ b/docs/openshift/openshift-local.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman.html b/docs/podman.html index 6189c6f500e..1ba5066eb38 100644 --- a/docs/podman.html +++ b/docs/podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/accessing-podman-from-another-wsl-instance.html b/docs/podman/accessing-podman-from-another-wsl-instance.html index 038639cc4f0..2e6922f20c0 100644 --- a/docs/podman/accessing-podman-from-another-wsl-instance.html +++ b/docs/podman/accessing-podman-from-another-wsl-instance.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/creating-a-podman-machine.html b/docs/podman/creating-a-podman-machine.html index 086d212c7fc..da2fdc8fe99 100644 --- a/docs/podman/creating-a-podman-machine.html +++ b/docs/podman/creating-a-podman-machine.html @@ -13,7 +13,7 @@ - + diff --git a/docs/podman/setting-podman-machine-default-connection.html b/docs/podman/setting-podman-machine-default-connection.html index 520596c73b9..712bcbfa309 100644 --- a/docs/podman/setting-podman-machine-default-connection.html +++ b/docs/podman/setting-podman-machine-default-connection.html @@ -13,7 +13,7 @@ - + diff --git a/docs/proxy.html b/docs/proxy.html index f49a9efdc8b..7445dfe2580 100644 --- a/docs/proxy.html +++ b/docs/proxy.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags.html b/docs/tags.html index 96c0079120d..87d185f127c 100644 --- a/docs/tags.html +++ b/docs/tags.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/ai.html b/docs/tags/ai.html index 56f6657cea1..5552dfbd73c 100644 --- a/docs/tags/ai.html +++ b/docs/tags/ai.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/api.html b/docs/tags/api.html index 797f46f910f..6f74c09c26f 100644 --- a/docs/tags/api.html +++ b/docs/tags/api.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/compose.html b/docs/tags/compose.html index 872a111e0c1..d482f9f9841 100644 --- a/docs/tags/compose.html +++ b/docs/tags/compose.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/containers.html b/docs/tags/containers.html index de934013de2..c1535ad8283 100644 --- a/docs/tags/containers.html +++ b/docs/tags/containers.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/docker.html b/docs/tags/docker.html index 6b0e8507b03..257d29e6f95 100644 --- a/docs/tags/docker.html +++ b/docs/tags/docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/extension.html b/docs/tags/extension.html index 5aeff23c8cf..822f224cc70 100644 --- a/docs/tags/extension.html +++ b/docs/tags/extension.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/flathub.html b/docs/tags/flathub.html index bb5fe51101e..0de0e42a3a6 100644 --- a/docs/tags/flathub.html +++ b/docs/tags/flathub.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/flatpak.html b/docs/tags/flatpak.html index b666bbef4c2..9450d9bd6d7 100644 --- a/docs/tags/flatpak.html +++ b/docs/tags/flatpak.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/generative-ai.html b/docs/tags/generative-ai.html index 757680070d2..26e4d4d8b98 100644 --- a/docs/tags/generative-ai.html +++ b/docs/tags/generative-ai.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/icons.html b/docs/tags/icons.html index 26a5efdc1fb..d21b005866d 100644 --- a/docs/tags/icons.html +++ b/docs/tags/icons.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/images.html b/docs/tags/images.html index 6dec1dae985..7a4d3b5e9a7 100644 --- a/docs/tags/images.html +++ b/docs/tags/images.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/installing.html b/docs/tags/installing.html index fb00ea6f8f4..ddb9036dd9b 100644 --- a/docs/tags/installing.html +++ b/docs/tags/installing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/kind.html b/docs/tags/kind.html index 5950ff3c5fb..5e47a8f8d44 100644 --- a/docs/tags/kind.html +++ b/docs/tags/kind.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/kubernetes.html b/docs/tags/kubernetes.html index fbcb870dafb..845e3d255a6 100644 --- a/docs/tags/kubernetes.html +++ b/docs/tags/kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/lima.html b/docs/tags/lima.html index 8271053dc43..3b2f02b8c88 100644 --- a/docs/tags/lima.html +++ b/docs/tags/lima.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/linux.html b/docs/tags/linux.html index e540e0c6782..cfe63b299ea 100644 --- a/docs/tags/linux.html +++ b/docs/tags/linux.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/llm.html b/docs/tags/llm.html index 060a2346f45..721f559fa52 100644 --- a/docs/tags/llm.html +++ b/docs/tags/llm.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/mac-0-s.html b/docs/tags/mac-0-s.html index 5175272eff0..e00eb084e61 100644 --- a/docs/tags/mac-0-s.html +++ b/docs/tags/mac-0-s.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/mac-os.html b/docs/tags/mac-os.html index 58472a23296..865ddbdd695 100644 --- a/docs/tags/mac-os.html +++ b/docs/tags/mac-os.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/macos.html b/docs/tags/macos.html index 38b8f34d547..6986013d1ed 100644 --- a/docs/tags/macos.html +++ b/docs/tags/macos.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/migrating-from-docker.html b/docs/tags/migrating-from-docker.html index 1290c239a64..7885e2eea9c 100644 --- a/docs/tags/migrating-from-docker.html +++ b/docs/tags/migrating-from-docker.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/migrating-to-kubernetes.html b/docs/tags/migrating-to-kubernetes.html index f83cee8691e..df8ae2f38df 100644 --- a/docs/tags/migrating-to-kubernetes.html +++ b/docs/tags/migrating-to-kubernetes.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/minikube.html b/docs/tags/minikube.html index bc4cc09efbf..7f9ca6b539c 100644 --- a/docs/tags/minikube.html +++ b/docs/tags/minikube.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/onboarding.html b/docs/tags/onboarding.html index ed0d32ff002..e1e20b73320 100644 --- a/docs/tags/onboarding.html +++ b/docs/tags/onboarding.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/openshift.html b/docs/tags/openshift.html index ced334b05d8..66ebe72ab23 100644 --- a/docs/tags/openshift.html +++ b/docs/tags/openshift.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/podman-desktop.html b/docs/tags/podman-desktop.html index 373e0c1373f..68d675cb521 100644 --- a/docs/tags/podman-desktop.html +++ b/docs/tags/podman-desktop.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/podman.html b/docs/tags/podman.html index 0fd35395093..f74d631d85f 100644 --- a/docs/tags/podman.html +++ b/docs/tags/podman.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/pods.html b/docs/tags/pods.html index 13a31a15be8..c2a00f9150b 100644 --- a/docs/tags/pods.html +++ b/docs/tags/pods.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/publishing.html b/docs/tags/publishing.html index eef7ada0962..0570268834a 100644 --- a/docs/tags/publishing.html +++ b/docs/tags/publishing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/when-clause.html b/docs/tags/when-clause.html index 50c072c001f..4a3791022a1 100644 --- a/docs/tags/when-clause.html +++ b/docs/tags/when-clause.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/windows.html b/docs/tags/windows.html index 0d1b42558ae..b07a0218bdb 100644 --- a/docs/tags/windows.html +++ b/docs/tags/windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/tags/writing.html b/docs/tags/writing.html index 4e70f75b542..4812a02a1bb 100644 --- a/docs/tags/writing.html +++ b/docs/tags/writing.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting.html b/docs/troubleshooting.html index cc6a6236380..e948bb9bfae 100644 --- a/docs/troubleshooting.html +++ b/docs/troubleshooting.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-openshift-local.html b/docs/troubleshooting/troubleshooting-openshift-local.html index e91355e02d9..79f8c4c6d97 100644 --- a/docs/troubleshooting/troubleshooting-openshift-local.html +++ b/docs/troubleshooting/troubleshooting-openshift-local.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-linux.html b/docs/troubleshooting/troubleshooting-podman-on-linux.html index 8e3ce0174cb..307d18bf41c 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-linux.html +++ b/docs/troubleshooting/troubleshooting-podman-on-linux.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-macos.html b/docs/troubleshooting/troubleshooting-podman-on-macos.html index 4300fa6cc27..4b4eb6ce64f 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-macos.html +++ b/docs/troubleshooting/troubleshooting-podman-on-macos.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman-on-windows.html b/docs/troubleshooting/troubleshooting-podman-on-windows.html index b65c68b5525..c909dba31d9 100644 --- a/docs/troubleshooting/troubleshooting-podman-on-windows.html +++ b/docs/troubleshooting/troubleshooting-podman-on-windows.html @@ -13,7 +13,7 @@ - + diff --git a/docs/troubleshooting/troubleshooting-podman.html b/docs/troubleshooting/troubleshooting-podman.html index df68c969050..e5cf037e65f 100644 --- a/docs/troubleshooting/troubleshooting-podman.html +++ b/docs/troubleshooting/troubleshooting-podman.html @@ -13,7 +13,7 @@ - + diff --git a/downloads.html b/downloads.html index 26badaf4c67..6343cfd13d6 100644 --- a/downloads.html +++ b/downloads.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/linux.html b/downloads/linux.html index e9bd14571d3..8ac69b732db 100644 --- a/downloads/linux.html +++ b/downloads/linux.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/macos.html b/downloads/macos.html index 467acb21154..f39be9a4f0f 100644 --- a/downloads/macos.html +++ b/downloads/macos.html @@ -13,7 +13,7 @@ - + diff --git a/downloads/windows.html b/downloads/windows.html index 6455daaef4c..fe015843597 100644 --- a/downloads/windows.html +++ b/downloads/windows.html @@ -13,7 +13,7 @@ - + diff --git a/extend.html b/extend.html index 1ecb009ceda..beb243ac374 100644 --- a/extend.html +++ b/extend.html @@ -13,7 +13,7 @@ - + diff --git a/extensions/ai-lab.html b/extensions/ai-lab.html index 0751c47af2e..22cf7c912d8 100644 --- a/extensions/ai-lab.html +++ b/extensions/ai-lab.html @@ -13,7 +13,7 @@ - + diff --git a/features.html b/features.html index 773943e80e8..9cbfdcb3631 100644 --- a/features.html +++ b/features.html @@ -13,7 +13,7 @@ - + diff --git a/index.html b/index.html index 289dc71da1c..c355255841c 100644 --- a/index.html +++ b/index.html @@ -13,7 +13,7 @@ - + diff --git a/search.html b/search.html index e4f996652d0..62c8e323e00 100644 --- a/search.html +++ b/search.html @@ -13,7 +13,7 @@ - +