diff --git a/404.html b/404.html index 163d98b341c..1fe7b3d8932 100644 --- a/404.html +++ b/404.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/api.html b/api.html index 06127db4c1b..a261bdab621 100644 --- a/api.html +++ b/api.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

@podman-desktop/api

diff --git a/api/classes/CancellationTokenSource.html b/api/classes/CancellationTokenSource.html index b2e460b2052..8c5fb12a774 100644 --- a/api/classes/CancellationTokenSource.html +++ b/api/classes/CancellationTokenSource.html @@ -13,8 +13,8 @@ - - + +

Class: CancellationTokenSource

@@ -32,7 +32,7 @@

The cancellation token of this source.

Source​

-

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

+

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

Methods​

cancel()​

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

Returns​

void

Source​

-

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

+

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

dispose()​

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

Returns​

void

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/classes/Disposable.html b/api/classes/Disposable.html index b9dbe020b39..9c7e2ec361f 100644 --- a/api/classes/Disposable.html +++ b/api/classes/Disposable.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Class: Disposable

@@ -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 7a62b642c51..d40332caecf 100644 --- a/api/classes/EventEmitter.html +++ b/api/classes/EventEmitter.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Class: EventEmitter<T>

@@ -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 b48d0e48b40..efc4da92a90 100644 --- a/api/classes/TelemetryTrustedValue.html +++ b/api/classes/TelemetryTrustedValue.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/classes/Uri.html b/api/classes/Uri.html index 3243d25e23d..08a5e2c829e 100644 --- a/api/classes/Uri.html +++ b/api/classes/Uri.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Class: Uri

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

Returns​

Uri

Source​

-

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

+

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

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:1419

+

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

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:1439

+

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

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:1429

+

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

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:1424

+

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

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:1434

+

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

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:1413

+

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

Methods​

toString()​

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

Returns​

string

Source​

-

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

+

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

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:1455

+

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

file()​

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

Returns​

Uri

Source​

-

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

+

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

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:1402

+

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

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:1386

+

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

\ No newline at end of file diff --git a/api/enumerations/InputBoxValidationSeverity.html b/api/enumerations/InputBoxValidationSeverity.html index b79fa4a331d..3551b4779b5 100644 --- a/api/enumerations/InputBoxValidationSeverity.html +++ b/api/enumerations/InputBoxValidationSeverity.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/enumerations/ProgressLocation.html b/api/enumerations/ProgressLocation.html index 1e8f2ae51f5..7fefefc04de 100644 --- a/api/enumerations/ProgressLocation.html +++ b/api/enumerations/ProgressLocation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Enumeration: ProgressLocation

@@ -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:856

+

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

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:861

+

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

\ No newline at end of file diff --git a/api/enumerations/QuickPickItemKind.html b/api/enumerations/QuickPickItemKind.html index 748e8a28150..97e9f8325b6 100644 --- a/api/enumerations/QuickPickItemKind.html +++ b/api/enumerations/QuickPickItemKind.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Enumeration: QuickPickItemKind

@@ -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:1031

+

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

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:1027

+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRecord.html b/api/interfaces/AuditRecord.html index d619d9ec2c9..59019591012 100644 --- a/api/interfaces/AuditRecord.html +++ b/api/interfaces/AuditRecord.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/AuditRequestItems.html b/api/interfaces/AuditRequestItems.html index e3bb5b63525..4516741c210 100644 --- a/api/interfaces/AuditRequestItems.html +++ b/api/interfaces/AuditRequestItems.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuditRequestItems

diff --git a/api/interfaces/AuditResult.html b/api/interfaces/AuditResult.html index d3b2bc69cd3..51a968b0e5e 100644 --- a/api/interfaces/AuditResult.html +++ b/api/interfaces/AuditResult.html @@ -13,8 +13,8 @@ - - + +
+

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

\ No newline at end of file diff --git a/api/interfaces/Auditor.html b/api/interfaces/Auditor.html index fda4b6f76b8..16d4665b68a 100644 --- a/api/interfaces/Auditor.html +++ b/api/interfaces/Auditor.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/AuthConfig.html b/api/interfaces/AuthConfig.html index cf96a680d0d..b1e12762be0 100644 --- a/api/interfaces/AuthConfig.html +++ b/api/interfaces/AuthConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthConfig

@@ -24,27 +24,27 @@

optional email: string

Source​

-

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

+

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

password​

password: string

Source​

-

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

+

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

serveraddress​

serveraddress: string

Source​

-

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

+

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

username​

username: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationGetSessionOptions.html b/api/interfaces/AuthenticationGetSessionOptions.html index 0670c729c5a..394cffb4bb3 100644 --- a/api/interfaces/AuthenticationGetSessionOptions.html +++ b/api/interfaces/AuthenticationGetSessionOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthenticationGetSessionOptions

@@ -30,7 +30,7 @@ prompted to select an account to use when getSession is called with this flag.

Defaults to false.

Source​

-

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

+

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

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:3566

+

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

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:3590

+

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

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:3602

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProvider.html b/api/interfaces/AuthenticationProvider.html index 52c6eb1a237..82abd1925fe 100644 --- a/api/interfaces/AuthenticationProvider.html +++ b/api/interfaces/AuthenticationProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthenticationProvider

@@ -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:3673

+

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

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:3696

+

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

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:3681

+

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

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:3706

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html index b6eddb2ce51..c3bd78d8283 100644 --- a/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html +++ b/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthenticationProviderAuthenticationSessionsChangeEvent

@@ -26,7 +26,7 @@

The AuthenticationSessions of the AuthenticationProvider that have been added.

Source​

-

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

+

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

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:3662

+

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

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:3655

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderInformation.html b/api/interfaces/AuthenticationProviderInformation.html index f6bc269783b..3b5e1adb3e9 100644 --- a/api/interfaces/AuthenticationProviderInformation.html +++ b/api/interfaces/AuthenticationProviderInformation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationProviderOptions.html b/api/interfaces/AuthenticationProviderOptions.html index dc19cc859d5..0ad9bd9c352 100644 --- a/api/interfaces/AuthenticationProviderOptions.html +++ b/api/interfaces/AuthenticationProviderOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthenticationProviderOptions

@@ -25,7 +25,7 @@

optional readonly images: ProviderImages

Source​

-

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

+

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

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:3638

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSession.html b/api/interfaces/AuthenticationSession.html index c50d762a58d..1aa9d7ce4bd 100644 --- a/api/interfaces/AuthenticationSession.html +++ b/api/interfaces/AuthenticationSession.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: AuthenticationSession

@@ -26,7 +26,7 @@

The access token.

Source​

-

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

+

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

account​

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

The account associated with the session.

Source​

-

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

+

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

id​

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

The identifier of the authentication session.

Source​

-

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

+

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

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:3532

+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionAccountInformation.html b/api/interfaces/AuthenticationSessionAccountInformation.html index fcdea1d7846..27859585ae5 100644 --- a/api/interfaces/AuthenticationSessionAccountInformation.html +++ b/api/interfaces/AuthenticationSessionAccountInformation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/AuthenticationSessionsChangeEvent.html b/api/interfaces/AuthenticationSessionsChangeEvent.html index c092458143f..2acc0e0e74d 100644 --- a/api/interfaces/AuthenticationSessionsChangeEvent.html +++ b/api/interfaces/AuthenticationSessionsChangeEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/BlkioStatEntry.html b/api/interfaces/BlkioStatEntry.html index 0f70f8d0fb5..906e7ab852c 100644 --- a/api/interfaces/BlkioStatEntry.html +++ b/api/interfaces/BlkioStatEntry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: BlkioStatEntry

@@ -24,27 +24,27 @@

major: number

Source​

-

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

+

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

minor​

minor: number

Source​

-

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

+

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

op​

op: string

Source​

-

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

+

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

value​

value: number

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BlkioStats.html b/api/interfaces/BlkioStats.html index 3d50af92af9..c9467a6c71d 100644 --- a/api/interfaces/BlkioStats.html +++ b/api/interfaces/BlkioStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: BlkioStats

@@ -24,55 +24,55 @@

io_merged_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_queue_recursive​

io_queue_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_service_bytes_recursive​

io_service_bytes_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_service_time_recursive​

io_service_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_serviced_recursive​

io_serviced_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_time_recursive​

io_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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

io_wait_time_recursive​

io_wait_time_recursive: BlkioStatEntry[]

Source​

-

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

+

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

sectors_recursive​

sectors_recursive: BlkioStatEntry[]

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/BuildImageOptions.html b/api/interfaces/BuildImageOptions.html index 88018810061..8436f1f75f2 100644 --- a/api/interfaces/BuildImageOptions.html +++ b/api/interfaces/BuildImageOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: BuildImageOptions

@@ -25,7 +25,7 @@

The abort controller for running the build image operation

Source​

-

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

+

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

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:3109

+

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

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:3051

+

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

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:3005

+

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

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:3095

+

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

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:3100

+

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

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:3090

+

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

cpushares?​

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

CPU shares (relative weight).

Source​

-

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

+

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

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:3030

+

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

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:3070

+

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

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:3124

+

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

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:3075

+

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

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:3080

+

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

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:3131

+

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

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:3152

+

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

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:3145

+

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

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:3015

+

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

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:3020

+

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

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:3056

+

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

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:3046

+

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

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:3039

+

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

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:3063

+

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

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:3114

+

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

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:3119

+

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

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:3010

+

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

target?​

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

Default: ""

Target build stage

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CPUStats.html b/api/interfaces/CPUStats.html index 273926aad59..e71636f8060 100644 --- a/api/interfaces/CPUStats.html +++ b/api/interfaces/CPUStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CPUStats

@@ -24,27 +24,27 @@

cpu_usage: CPUUsage

Source​

-

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

+

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

online_cpus​

online_cpus: number

Source​

-

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

+

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

system_cpu_usage​

system_cpu_usage: number

Source​

-

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

+

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

throttling_data​

throttling_data: ThrottlingData

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CPUUsage.html b/api/interfaces/CPUUsage.html index 3563054e6b1..8f83c433e09 100644 --- a/api/interfaces/CPUUsage.html +++ b/api/interfaces/CPUUsage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CPUUsage

@@ -24,27 +24,27 @@

percpu_usage: number[]

Source​

-

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

+

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

total_usage​

total_usage: number

Source​

-

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

+

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

usage_in_kernelmode​

usage_in_kernelmode: number

Source​

-

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

+

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

usage_in_usermode​

usage_in_usermode: number

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CancellationToken.html b/api/interfaces/CancellationToken.html index 487ba5e9b9b..35b06e2d2ec 100644 --- a/api/interfaces/CancellationToken.html +++ b/api/interfaces/CancellationToken.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/CheckResult.html b/api/interfaces/CheckResult.html index 621bf65ef4b..2016f664f79 100644 --- a/api/interfaces/CheckResult.html +++ b/api/interfaces/CheckResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CheckResult

@@ -24,34 +24,34 @@

optional description: string

Source​

-

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

+

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

optional docLinks: Link[]

Source​

-

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

+

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

docLinksDescription?​

optional docLinksDescription: string

Source​

-

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

+

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

fixCommand?​

optional fixCommand: CheckResultFixCommand

Source​

-

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

+

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

successful​

successful: boolean

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CheckResultFixCommand.html b/api/interfaces/CheckResultFixCommand.html index 56a71f04b59..572196a1985 100644 --- a/api/interfaces/CheckResultFixCommand.html +++ b/api/interfaces/CheckResultFixCommand.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/CliTool.html b/api/interfaces/CliTool.html index 22f37615270..f58c4266d42 100644 --- a/api/interfaces/CliTool.html +++ b/api/interfaces/CliTool.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CliTool

@@ -28,7 +28,7 @@

displayName: string

Source​

-

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

+

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

extensionInfo​

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

label: string

Source​

-

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

+

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

id​

id: string

Source​

-

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

+

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

images​

images: ProviderImages

Source​

-

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

+

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

markdownDescription​

markdownDescription: string

Source​

-

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

+

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

name​

name: string

Source​

-

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

+

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

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Source​

-

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

+

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

state​

state: "registered"

Source​

-

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

+

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

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:4169

+

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

updateVersion()​

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

Returns​

void

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolOptions.html b/api/interfaces/CliToolOptions.html index 12b57b7e217..b2a1442b0fc 100644 --- a/api/interfaces/CliToolOptions.html +++ b/api/interfaces/CliToolOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CliToolOptions

@@ -25,35 +25,35 @@

displayName: string

Source​

-

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

+

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

images​

images: ProviderImages

Source​

-

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

+

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

markdownDescription​

markdownDescription: string

Source​

-

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

+

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

name​

name: string

Source​

-

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

+

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

path​

path: string

Source​

-

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

+

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

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:4131

+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdate.html b/api/interfaces/CliToolUpdate.html index 8225e1624d8..c2ee182cc36 100644 --- a/api/interfaces/CliToolUpdate.html +++ b/api/interfaces/CliToolUpdate.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/CliToolUpdateOptions.html b/api/interfaces/CliToolUpdateOptions.html index b7b24b3f30b..89b2b52ae68 100644 --- a/api/interfaces/CliToolUpdateOptions.html +++ b/api/interfaces/CliToolUpdateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CliToolUpdateOptions

@@ -25,34 +25,34 @@

optional displayName: string

Source​

-

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

+

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

images?​

optional images: ProviderImages

Source​

-

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

+

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

markdownDescription?​

optional markdownDescription: string

Source​

-

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

+

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

path?​

optional path: string

Source​

-

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

+

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

version​

version: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/Clipboard.html b/api/interfaces/Clipboard.html index cc2a840d9f8..cbbba3885f7 100644 --- a/api/interfaces/Clipboard.html +++ b/api/interfaces/Clipboard.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/Command.html b/api/interfaces/Command.html index 1aed77808bf..dc0dc76be11 100644 --- a/api/interfaces/Command.html +++ b/api/interfaces/Command.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Command

@@ -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 6c2bef55c82..84573a39e31 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Configuration

@@ -36,7 +36,7 @@

undefined | T

The value section denotes or undefined.

Source​
-

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

+

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

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:794

+

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

has()​

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

boolean

true if the section doesn't resolve to undefined.

Source​

-

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

+

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

update()​

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

Returns​

Promise<void>

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ConfigurationChangeEvent.html b/api/interfaces/ConfigurationChangeEvent.html index f4fdda56ca7..8a1797a86c2 100644 --- a/api/interfaces/ConfigurationChangeEvent.html +++ b/api/interfaces/ConfigurationChangeEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerAuthInfo.html b/api/interfaces/ContainerAuthInfo.html index 3b7fde5b1b8..40713a69461 100644 --- a/api/interfaces/ContainerAuthInfo.html +++ b/api/interfaces/ContainerAuthInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerAuthInfo

@@ -25,27 +25,27 @@

optional email: string

Source​

-

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

+

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

password​

password: string

Source​

-

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

+

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

serveraddress​

serveraddress: string

Source​

-

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

+

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

username​

username: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerCreateOptions.html b/api/interfaces/ContainerCreateOptions.html index 829b44eb71a..117c20212ea 100644 --- a/api/interfaces/ContainerCreateOptions.html +++ b/api/interfaces/ContainerCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerCreateOptions

@@ -26,7 +26,7 @@

Default: false

Command is already escaped (Windows only)

Source​

-

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

+

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

AttachStderr?​

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

Whether to attach to stderr (default false)

Source​

-

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

+

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

AttachStdin?​

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

Whether to attach to stdin (default false)

Source​

-

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

+

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

AttachStdout?​

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

Whether to attach to stdout(default false)

Source​

-

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

+

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

Cmd?​

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

Command to run specified as an array of strings

Source​

-

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

+

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

Detach?​

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

Run the container in the background

Source​

-

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

+

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

Domainname?​

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

The domain name to use for the container.

Source​

-

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

+

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

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:2758

+

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

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:2715

+

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

EnvFiles?​

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

Environment files to use

Source​

-

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

+

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

ExposedPorts?​

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

Index signature​

[port: string]: object

Source​

-

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

+

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

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:2798

+

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

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:2736

+

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

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:2700

+

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

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:2741

+

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

Labels?​

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

Index signature​

[label: string]: string

Source​

-

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

+

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

MacAddress?​

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

MAC address of the container.

Source​

-

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

+

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

NetworkConfig?​

optional NetworkConfig: NetworkingConfig

Source​

-

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

+

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

NetworkDisabled?​

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

Disable networking for the container.

Source​

-

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

+

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

OnBuild?​

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

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

Source​

-

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

+

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

OpenStdin?​

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

Whether to open stdin (default false)

Source​

-

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

+

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

Shell?​

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

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

Source​

-

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

+

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

StdinOnce?​

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

Close stdin after one attached client disconnects (deafult false)

Source​

-

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

+

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

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:2835

+

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

StopTimeout?​

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

Default: 10

Timeout to stop a container in seconds.

Source​

-

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

+

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

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:2746

+

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

User?​

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

The user that commands are run as inside the container

Source​

-

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

+

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

Volumes?​

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

Index signature​

[volume: string]: object

Source​

-

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

+

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

WorkingDir?​

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

The working directory for commands to run in.

Source​

-

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

+

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

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:2678

+

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

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:2695

+

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

pod?​

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

Pod where to create the container in

Source​

-

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

+

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

start?​

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

Start the container immediately (default true)

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/ContainerCreateResult.html b/api/interfaces/ContainerCreateResult.html index 0a00c460219..c0b9a453397 100644 --- a/api/interfaces/ContainerCreateResult.html +++ b/api/interfaces/ContainerCreateResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerCreateResult

@@ -26,7 +26,7 @@

the engineId where the container is running

Source​

-

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

+

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

id​

@@ -34,6 +34,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:2864

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerEngineInfo.html b/api/interfaces/ContainerEngineInfo.html index 8ec69ec3989..a0c64270a2b 100644 --- a/api/interfaces/ContainerEngineInfo.html +++ b/api/interfaces/ContainerEngineInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerEngineInfo

@@ -26,7 +26,7 @@

Percentage of idle CPUs (for Podman engines only)

Source​

-

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

+

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

cpus?​

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

number of CPUs available for the container engine

Source​

-

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

+

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

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:3207

+

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

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:3211

+

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

engineId​

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

unique id identifying the container engine

Source​

-

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

+

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

engineName​

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

name of the container engine

Source​

-

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

+

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

engineType​

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

engine type, either 'podman' or 'docker'

Source​

-

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

+

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

memory?​

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

Quantity of memory available for the container engine

Source​

-

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

+

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

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:3203

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerInfo.html b/api/interfaces/ContainerInfo.html index f48a665c0ce..e862d533b5c 100644 --- a/api/interfaces/ContainerInfo.html +++ b/api/interfaces/ContainerInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerInfo

@@ -24,14 +24,14 @@

Command: string

Source​

-

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

+

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

Created​

Created: number

Source​

-

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

+

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

HostConfig​

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

NetworkMode: string

Source​

-

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

+

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

Id​

Id: string

Source​

-

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

+

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

Image​

Image: string

Source​

-

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

+

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

ImageID​

ImageID: string

Source​

-

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

+

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

Labels​

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

Index signature​

[label: string]: string

Source​

-

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

+

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

Mounts​

Mounts: object[]

Source​

-

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

+

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

Names​

Names: string[]

Source​

-

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

+

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

NetworkSettings​

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

[networkType: string]: NetworkInfo

Source​

-

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

+

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

Ports​

Ports: Port[]

Source​

-

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

+

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

State​

State: string

Source​

-

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

+

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

Status​

Status: string

Source​

-

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

+

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

engineId​

engineId: string

Source​

-

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

+

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

engineName​

engineName: string

Source​

-

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

+

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

engineType​

engineType: "docker" | "podman"

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerInspectInfo.html b/api/interfaces/ContainerInspectInfo.html index 32ec2f4f502..a64e0a290de 100644 --- a/api/interfaces/ContainerInspectInfo.html +++ b/api/interfaces/ContainerInspectInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerInspectInfo

@@ -24,14 +24,14 @@

AppArmorProfile: string

Source​

-

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

+

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

Args​

Args: string[]

Source​

-

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

+

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

Config​

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

WorkingDir: string

Source​

-

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

+

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

Created​

Created: string

Source​

-

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

+

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

Driver​

Driver: string

Source​

-

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

+

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

ExecIDs?​

optional ExecIDs: string[]

Source​

-

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

+

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

GraphDriver​

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

Name: string

Source​

-

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

+

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

HostConfig​

HostConfig: HostConfig

Source​

-

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

+

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

HostnamePath​

HostnamePath: string

Source​

-

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

+

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

HostsPath​

HostsPath: string

Source​

-

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

+

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

Id​

Id: string

Source​

-

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

+

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

Image​

Image: string

Source​

-

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

+

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

LogPath​

LogPath: string

Source​

-

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

+

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

MountLabel​

MountLabel: string

Source​

-

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

+

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

Mounts​

Mounts: object[]

Source​

-

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

+

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

Name​

Name: string

Source​

-

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

+

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

NetworkSettings​

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

optional SecondaryIPv6Addresses: unknown

Source​

-

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

+

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

Path​

Path: string

Source​

-

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

+

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

Platform​

Platform: string

Source​

-

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

+

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

ProcessLabel​

ProcessLabel: string

Source​

-

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

+

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

ResolvConfPath​

ResolvConfPath: string

Source​

-

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

+

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

RestartCount​

RestartCount: number

Source​

-

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

+

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

State​

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

Status: string

Source​

-

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

+

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

engineId​

engineId: string

Source​

-

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

+

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

engineName​

engineName: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerJSONEvent.html b/api/interfaces/ContainerJSONEvent.html index a866816bab1..65fa26b5cd5 100644 --- a/api/interfaces/ContainerJSONEvent.html +++ b/api/interfaces/ContainerJSONEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerJSONEvent

@@ -24,27 +24,27 @@

optional Type: string

Source​

-

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

+

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

id​

id: string

Source​

-

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

+

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

status​

status: string

Source​

-

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

+

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

type​

type: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnection.html b/api/interfaces/ContainerProviderConnection.html index 0d59e6ddcb8..36555c8357a 100644 --- a/api/interfaces/ContainerProviderConnection.html +++ b/api/interfaces/ContainerProviderConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerProviderConnection

@@ -24,28 +24,28 @@

endpoint: ContainerProviderConnectionEndpoint

Source​

-

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

+

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

lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

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

+

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

name​

name: string

Source​

-

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

+

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

type​

type: "docker" | "podman"

Source​

-

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

+

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

Methods​

status()​

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

Returns​

ProviderConnectionStatus

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnectionEndpoint.html b/api/interfaces/ContainerProviderConnectionEndpoint.html index 015627d78a5..019f02657b3 100644 --- a/api/interfaces/ContainerProviderConnectionEndpoint.html +++ b/api/interfaces/ContainerProviderConnectionEndpoint.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerProviderConnectionFactory.html b/api/interfaces/ContainerProviderConnectionFactory.html index c082bc5a9ab..d55eb5e6e87 100644 --- a/api/interfaces/ContainerProviderConnectionFactory.html +++ b/api/interfaces/ContainerProviderConnectionFactory.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerProviderConnectionFactory

@@ -30,7 +30,7 @@

Inherited from​

ProviderConnectionFactory . creationButtonTitle

Source​

-

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

+

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

creationDisplayName?​

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

Inherited from​

ProviderConnectionFactory . creationDisplayName

Source​

-

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

+

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

Methods​

create()​

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

Returns​

Promise<void>

Source​

-

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

+

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

initialize()?​

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

Inherited from​

ProviderConnectionFactory . initialize

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ContainerStatsInfo.html b/api/interfaces/ContainerStatsInfo.html index dbc0c7a287f..f25d9053b13 100644 --- a/api/interfaces/ContainerStatsInfo.html +++ b/api/interfaces/ContainerStatsInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ContainerStatsInfo

@@ -24,83 +24,83 @@

optional blkio_stats: BlkioStats

Source​

-

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

+

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

cpu_stats​

cpu_stats: CPUStats

Source​

-

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

+

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

engineId​

engineId: string

Source​

-

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

+

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

engineName​

engineName: string

Source​

-

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

+

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

memory_stats​

memory_stats: MemoryStats

Source​

-

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

+

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

networks​

networks: NetworkStats

Source​

-

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

+

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

num_procs​

num_procs: number

Source​

-

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

+

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

pids_stats?​

optional pids_stats: PidsStats

Source​

-

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

+

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

precpu_stats​

precpu_stats: CPUStats

Source​

-

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

+

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

preread​

preread: string

Source​

-

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

+

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

read​

read: string

Source​

-

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

+

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

storage_stats?​

optional storage_stats: StorageStats

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPick.html b/api/interfaces/CustomPick.html index b6f9ee1a67f..09d03e14374 100644 --- a/api/interfaces/CustomPick.html +++ b/api/interfaces/CustomPick.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CustomPick<T>

@@ -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:1227

+

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

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:1215

+

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

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:1233

+

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

icon?​

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

An optional base64 PNG image

Source​

-

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

+

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

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:1223

+

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

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:1239

+

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

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:1243

+

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

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:1247

+

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

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:1211

+

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

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:1261

+

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

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:1255

+

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

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:1251

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPickItem.html b/api/interfaces/CustomPickItem.html index 490ae3508e1..22b59559928 100644 --- a/api/interfaces/CustomPickItem.html +++ b/api/interfaces/CustomPickItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CustomPickItem

@@ -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:1188

+

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

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:1192

+

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

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:1196

+

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

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:1200

+

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

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:1184

+

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

\ No newline at end of file diff --git a/api/interfaces/CustomPickSectionItem.html b/api/interfaces/CustomPickSectionItem.html index 18c148a09d9..ed3e485e5f7 100644 --- a/api/interfaces/CustomPickSectionItem.html +++ b/api/interfaces/CustomPickSectionItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: CustomPickSectionItem

@@ -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:1168

+

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

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:1173

+

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

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:1163

+

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

\ No newline at end of file diff --git a/api/interfaces/DeviceRequest.html b/api/interfaces/DeviceRequest.html index 30903363a42..546aa9f6bb3 100644 --- a/api/interfaces/DeviceRequest.html +++ b/api/interfaces/DeviceRequest.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: DeviceRequest

@@ -24,28 +24,28 @@

optional Capabilities: string[][]

Source​

-

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

+

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

Count?​

optional Count: number

Source​

-

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

+

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

DeviceIDs?​

optional DeviceIDs: string[]

Source​

-

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

+

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

Driver?​

optional Driver: string

Source​

-

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

+

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

Options?​

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

Index signature​

[key: string]: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/EndpointIPAMConfig.html b/api/interfaces/EndpointIPAMConfig.html index c5e5cb5f771..f76eff9ead0 100644 --- a/api/interfaces/EndpointIPAMConfig.html +++ b/api/interfaces/EndpointIPAMConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: EndpointIPAMConfig

@@ -24,20 +24,20 @@

optional IPv4Address: string

Source​

-

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

+

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

IPv6Address?​

optional IPv6Address: string

Source​

-

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

+

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

LinkLocalIPs?​

optional LinkLocalIPs: string[]

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/EndpointSettings.html b/api/interfaces/EndpointSettings.html index d6faaebeb4b..3425d0382da 100644 --- a/api/interfaces/EndpointSettings.html +++ b/api/interfaces/EndpointSettings.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: EndpointSettings

@@ -24,7 +24,7 @@

optional Aliases: string[]

Source​

-

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

+

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

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:2646

+

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

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:2636

+

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

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:2601

+

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

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:2606

+

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

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:2626

+

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

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:2631

+

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

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:2582

+

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

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:2611

+

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

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:2616

+

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

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:2621

+

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

optional Links: string[]

Source​

-

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

+

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

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:2589

+

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

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:2596

+

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

\ No newline at end of file diff --git a/api/interfaces/Event.html b/api/interfaces/Event.html index fa19eed22d9..02f713a951d 100644 --- a/api/interfaces/Event.html +++ b/api/interfaces/Event.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/Extension.html b/api/interfaces/Extension.html index 9e1b7b9be96..8e8b3676a21 100644 --- a/api/interfaces/Extension.html +++ b/api/interfaces/Extension.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Extension<T>

@@ -30,7 +30,7 @@

The public API exported by this extension (return value of activate). It is an invalid action to access this field before this extension has been activated.

Source​

-

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

+

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

extensionPath​

@@ -39,7 +39,7 @@ It is an invalid action to access this field before this extension has been acti

The absolute file path of the directory containing this extension. Shorthand notation for Extension.extensionUri.fsPath (independent of the uri scheme).

Source​

-

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

+

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

extensionUri​

@@ -47,7 +47,7 @@ notation for Extension.extensio

The uri of the directory containing the extension.

Source​

-

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

+

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

id​

@@ -55,7 +55,7 @@ notation for Extension.extensio

The canonical extension identifier in the form of: publisher.name.

Source​

-

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

+

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

packageJSON​

@@ -63,6 +63,6 @@ notation for Extension.extensio

The parsed contents of the extension's package.json.

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ExtensionContext.html b/api/interfaces/ExtensionContext.html index 0edbfce75d8..4c74d0e10a4 100644 --- a/api/interfaces/ExtensionContext.html +++ b/api/interfaces/ExtensionContext.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ExtensionContext

@@ -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 4406489e831..7469feb80c4 100644 --- a/api/interfaces/FileSystemWatcher.html +++ b/api/interfaces/FileSystemWatcher.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: FileSystemWatcher

@@ -29,21 +29,21 @@

readonly onDidChange: Event <Uri>

Source​

-

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

+

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

onDidCreate​

readonly onDidCreate: Event <Uri>

Source​

-

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

+

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

onDidDelete​

readonly onDidDelete: Event <Uri>

Source​

-

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

+

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

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 dae1484d70e..cd43a37f6ac 100644 --- a/api/interfaces/GenerateKubeResult.html +++ b/api/interfaces/GenerateKubeResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/HealthCheckLog.html b/api/interfaces/HealthCheckLog.html index 10b72184809..0234777bda7 100644 --- a/api/interfaces/HealthCheckLog.html +++ b/api/interfaces/HealthCheckLog.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: HealthCheckLog

@@ -26,7 +26,7 @@

End time as a string

Source​

-

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

+

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

ExitCode​

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

Exitcode is 0 or 1

Source​

-

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

+

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

Output​

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

Output is the stdout/stderr from the healthcheck command

Source​

-

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

+

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

Start​

@@ -50,6 +50,6 @@

Start time as string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HealthCheckResults.html b/api/interfaces/HealthCheckResults.html index d8164a18330..ba0f047bb9f 100644 --- a/api/interfaces/HealthCheckResults.html +++ b/api/interfaces/HealthCheckResults.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: HealthCheckResults

@@ -26,7 +26,7 @@

FailingStreak is the number of consecutive failed healthchecks

Source​

-

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

+

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

Log​

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

Log describes healthcheck attempts and results

Source​

-

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

+

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

Status​

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

Status is starting, healthy or unhealthy

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HealthConfig.html b/api/interfaces/HealthConfig.html index bc4f1cb7ed2..89e6082b89d 100644 --- a/api/interfaces/HealthConfig.html +++ b/api/interfaces/HealthConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: HealthConfig

@@ -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:2541

+

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

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:2569

+

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

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:2560

+

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

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:2532

+

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

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:2550

+

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

\ No newline at end of file diff --git a/api/interfaces/HostConfig.html b/api/interfaces/HostConfig.html index 931fa2130d3..abe52ee824b 100644 --- a/api/interfaces/HostConfig.html +++ b/api/interfaces/HostConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: HostConfig

@@ -24,259 +24,259 @@

optional AutoRemove: boolean

Source​

-

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

+

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

Binds?​

optional Binds: string[]

Source​

-

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

+

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

BlkioDeviceReadBps?​

optional BlkioDeviceReadBps: unknown

Source​

-

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

+

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

BlkioDeviceReadIOps?​

optional BlkioDeviceReadIOps: unknown

Source​

-

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

+

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

BlkioDeviceWriteBps?​

optional BlkioDeviceWriteBps: unknown

Source​

-

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

+

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

BlkioDeviceWriteIOps?​

optional BlkioDeviceWriteIOps: unknown

Source​

-

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

+

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

BlkioWeight?​

optional BlkioWeight: number

Source​

-

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

+

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

BlkioWeightDevice?​

optional BlkioWeightDevice: unknown

Source​

-

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

+

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

CapAdd?​

optional CapAdd: string[]

Source​

-

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

+

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

CapDrop?​

optional CapDrop: string[]

Source​

-

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

+

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

Cgroup?​

optional Cgroup: string

Source​

-

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

+

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

CgroupParent?​

optional CgroupParent: string

Source​

-

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

+

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

ConsoleSize?​

optional ConsoleSize: number[]

Source​

-

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

+

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

ContainerIDFile?​

optional ContainerIDFile: string

Source​

-

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

+

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

CpuCount?​

optional CpuCount: number

Source​

-

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

+

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

CpuPercent?​

optional CpuPercent: number

Source​

-

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

+

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

CpuPeriod?​

optional CpuPeriod: number

Source​

-

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

+

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

CpuQuota?​

optional CpuQuota: number

Source​

-

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

+

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

CpuRealtimePeriod?​

optional CpuRealtimePeriod: number

Source​

-

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

+

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

CpuRealtimeRuntime?​

optional CpuRealtimeRuntime: number

Source​

-

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

+

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

CpuShares?​

optional CpuShares: number

Source​

-

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

+

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

CpusetCpus?​

optional CpusetCpus: string

Source​

-

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

+

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

CpusetMems?​

optional CpusetMems: string

Source​

-

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

+

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

DeviceCgroupRules?​

optional DeviceCgroupRules: string[]

Source​

-

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

+

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

DeviceRequests?​

optional DeviceRequests: DeviceRequest[]

Source​

-

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

+

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

Devices?​

optional Devices: unknown

Source​

-

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

+

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

DiskQuota?​

optional DiskQuota: number

Source​

-

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

+

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

Dns?​

optional Dns: string[]

Source​

-

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

+

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

DnsOptions?​

optional DnsOptions: unknown[]

Source​

-

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

+

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

DnsSearch?​

optional DnsSearch: string[]

Source​

-

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

+

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

ExtraHosts?​

optional ExtraHosts: string[]

Source​

-

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

+

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

GroupAdd?​

optional GroupAdd: string[]

Source​

-

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

+

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

Init?​

optional Init: boolean

Source​

-

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

+

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

IpcMode?​

optional IpcMode: string

Source​

-

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

+

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

Isolation?​

optional Isolation: string

Source​

-

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

+

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

KernelMemory?​

optional KernelMemory: number

Source​

-

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

+

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

optional Links: unknown

Source​

-

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

+

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

LogConfig?​

@@ -291,154 +291,154 @@

Type: string

Source​

-

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

+

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

MaskedPaths?​

optional MaskedPaths: string[]

Source​

-

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

+

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

Memory?​

optional Memory: number

Source​

-

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

+

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

MemoryReservation?​

optional MemoryReservation: number

Source​

-

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

+

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

MemorySwap?​

optional MemorySwap: number

Source​

-

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

+

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

MemorySwappiness?​

optional MemorySwappiness: number

Source​

-

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

+

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

Mounts?​

optional Mounts: MountConfig

Source​

-

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

+

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

NanoCpus?​

optional NanoCpus: number

Source​

-

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

+

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

NetworkMode?​

optional NetworkMode: string

Source​

-

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

+

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

OomKillDisable?​

optional OomKillDisable: boolean

Source​

-

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

+

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

OomScoreAdj?​

optional OomScoreAdj: number

Source​

-

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

+

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

PidMode?​

optional PidMode: string

Source​

-

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

+

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

PidsLimit?​

optional PidsLimit: number

Source​

-

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

+

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

PortBindings?​

optional PortBindings: unknown

Source​

-

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

+

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

Privileged?​

optional Privileged: boolean

Source​

-

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

+

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

PublishAllPorts?​

optional PublishAllPorts: boolean

Source​

-

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

+

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

ReadonlyPaths?​

optional ReadonlyPaths: string[]

Source​

-

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

+

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

ReadonlyRootfs?​

optional ReadonlyRootfs: boolean

Source​

-

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

+

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

RestartPolicy?​

optional RestartPolicy: HostRestartPolicy

Source​

-

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

+

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

Runtime?​

optional Runtime: string

Source​

-

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

+

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

SecurityOpt?​

optional SecurityOpt: string[]

Source​

-

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

+

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

ShmSize?​

optional ShmSize: number

Source​

-

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

+

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

StorageOpt?​

@@ -447,7 +447,7 @@

Index signature​

[option: string]: string

Source​

-

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

+

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

Sysctls?​

@@ -456,7 +456,7 @@

Index signature​

[index: string]: string

Source​

-

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

+

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

Tmpfs?​

@@ -465,41 +465,41 @@

Index signature​

[dir: string]: string

Source​

-

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

+

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

UTSMode?​

optional UTSMode: string

Source​

-

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

+

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

Ulimits?​

optional Ulimits: unknown

Source​

-

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

+

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

UsernsMode?​

optional UsernsMode: string

Source​

-

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

+

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

VolumeDriver?​

optional VolumeDriver: string

Source​

-

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

+

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

VolumesFrom?​

optional VolumesFrom: unknown

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/HostRestartPolicy.html b/api/interfaces/HostRestartPolicy.html index fe51dccf6f0..90bb726cbf6 100644 --- a/api/interfaces/HostRestartPolicy.html +++ b/api/interfaces/HostRestartPolicy.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/IPAM.html b/api/interfaces/IPAM.html index 7f9e9883500..f88e982f950 100644 --- a/api/interfaces/IPAM.html +++ b/api/interfaces/IPAM.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ImageCheck.html b/api/interfaces/ImageCheck.html index 51159f22089..7f9d76a6832 100644 --- a/api/interfaces/ImageCheck.html +++ b/api/interfaces/ImageCheck.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ImageCheck

@@ -26,7 +26,7 @@

full description of the error/recommendation

Source​

-

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

+

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

name​

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

a short and descriptive name for the error/recommendation

Source​

-

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

+

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

severity?​

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

severity of the error/recommendation, when the status is failed

Source​

-

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

+

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

status​

@@ -50,6 +50,6 @@

either the feedback is positive or negative

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/interfaces/ImageCheckerProvider.html b/api/interfaces/ImageCheckerProvider.html index 4fc70a21bcc..ca507080a16 100644 --- a/api/interfaces/ImageCheckerProvider.html +++ b/api/interfaces/ImageCheckerProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ImageCheckerProviderMetadata.html b/api/interfaces/ImageCheckerProviderMetadata.html index 40fe16edffd..58ec4dee1b9 100644 --- a/api/interfaces/ImageCheckerProviderMetadata.html +++ b/api/interfaces/ImageCheckerProviderMetadata.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ImageChecks.html b/api/interfaces/ImageChecks.html index b9bdb2e6736..713c440b08a 100644 --- a/api/interfaces/ImageChecks.html +++ b/api/interfaces/ImageChecks.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/ImageInfo.html b/api/interfaces/ImageInfo.html index 556ebff031e..3a052bee700 100644 --- a/api/interfaces/ImageInfo.html +++ b/api/interfaces/ImageInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ImageInfo

@@ -24,35 +24,35 @@

Containers: number

Source​

-

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

+

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

Created​

Created: number

Source​

-

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

+

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

Digest​

Digest: string

Source​

-

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

+

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

History?​

optional History: string[]

Source​

-

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

+

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

Id​

Id: string

Source​

-

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

+

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

Labels​

@@ -61,69 +61,69 @@

Index signature​

[label: string]: string

Source​

-

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

+

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

ParentId​

ParentId: string

Source​

-

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

+

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

RepoDigests?​

optional RepoDigests: string[]

Source​

-

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

+

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

RepoTags​

RepoTags: undefined | string[]

Source​

-

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

+

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

SharedSize​

SharedSize: number

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:1979

+

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

VirtualSize​

VirtualSize: number

Source​

-

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

+

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

engineId​

engineId: string

Source​

-

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

+

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

engineName​

engineName: string

Source​

-

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

+

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

isManifest?​

optional isManifest: boolean

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/ImageInspectInfo.html b/api/interfaces/ImageInspectInfo.html index f3719e11b7e..2969bd5ee03 100644 --- a/api/interfaces/ImageInspectInfo.html +++ b/api/interfaces/ImageInspectInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ImageInspectInfo

@@ -24,21 +24,21 @@

Architecture: string

Source​

-

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

+

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

Author​

Author: string

Source​

-

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

+

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

Comment​

Comment: string

Source​

-

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

+

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

Config​

@@ -127,14 +127,14 @@

WorkingDir: string

Source​

-

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

+

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

Container​

Container: string

Source​

-

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

+

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

ContainerConfig​

@@ -223,21 +223,21 @@

WorkingDir: string

Source​

-

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

+

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

Created​

Created: string

Source​

-

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

+

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

DockerVersion​

DockerVersion: string

Source​

-

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

+

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

GraphDriver​

@@ -264,42 +264,42 @@

Name: string

Source​

-

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

+

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

Id​

Id: string

Source​

-

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

+

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

Os​

Os: string

Source​

-

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

+

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

Parent​

Parent: string

Source​

-

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

+

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

RepoDigests​

RepoDigests: string[]

Source​

-

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

+

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

RepoTags​

RepoTags: string[]

Source​

-

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

+

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

RootFS​

@@ -318,34 +318,34 @@

Type: string

Source​

-

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

+

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

Size​

Size: number

Source​

-

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

+

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

VirtualSize​

VirtualSize: number

Source​

-

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

+

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

engineId​

engineId: string

Source​

-

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

+

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

engineName​

engineName: string

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/InputBoxOptions.html b/api/interfaces/InputBoxOptions.html index ac3464d385f..d064451addf 100644 --- a/api/interfaces/InputBoxOptions.html +++ b/api/interfaces/InputBoxOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: InputBoxOptions

@@ -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:994

+

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

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:978

+

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

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:999

+

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

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:988

+

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

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:983

+

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

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:973

+

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

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:955

+

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

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:960

+

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

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:968

+

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

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:1009

+

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

\ No newline at end of file diff --git a/api/interfaces/InputBoxValidationMessage.html b/api/interfaces/InputBoxValidationMessage.html index 2e59b1be6bc..7040b338762 100644 --- a/api/interfaces/InputBoxValidationMessage.html +++ b/api/interfaces/InputBoxValidationMessage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: InputBoxValidationMessage

@@ -26,7 +26,7 @@

The validation message to display.

Source​

-

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

+

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

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:945

+

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

\ No newline at end of file diff --git a/api/interfaces/InstallCheck.html b/api/interfaces/InstallCheck.html index ee84a9d078d..0637c1b5d21 100644 --- a/api/interfaces/InstallCheck.html +++ b/api/interfaces/InstallCheck.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: InstallCheck

@@ -24,7 +24,7 @@

title: string

Source​

-

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

+

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

Methods​

execute()​

@@ -33,7 +33,7 @@

Returns​

Promise <CheckResult>

Source​

-

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

+

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

init()?​

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

Returns​

Promise<void>

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/KubeconfigUpdateEvent.html b/api/interfaces/KubeconfigUpdateEvent.html index 5eb04af9839..b110623b4fa 100644 --- a/api/interfaces/KubeconfigUpdateEvent.html +++ b/api/interfaces/KubeconfigUpdateEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

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

\ No newline at end of file diff --git a/api/interfaces/KubernetesGeneratorProvider.html b/api/interfaces/KubernetesGeneratorProvider.html index a3925cd3b54..ea7c3fcf225 100644 --- a/api/interfaces/KubernetesGeneratorProvider.html +++ b/api/interfaces/KubernetesGeneratorProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: KubernetesGeneratorProvider

@@ -26,14 +26,14 @@ KubernetesGeneratorType.

name: string

Source​

-

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

+

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

types​

types: KubernetesGeneratorSelector

Source​

-

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

+

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

Methods​

generate()​

@@ -44,6 +44,6 @@ KubernetesGeneratorType.

Returns​

Promise <GenerateKubeResult>

Source​

-

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

+

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

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnection.html b/api/interfaces/KubernetesProviderConnection.html index 0b00cee2d4c..a7653dfe81e 100644 --- a/api/interfaces/KubernetesProviderConnection.html +++ b/api/interfaces/KubernetesProviderConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: KubernetesProviderConnection

@@ -24,21 +24,21 @@

endpoint: KubernetesProviderConnectionEndpoint

Source​

-

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

+

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

lifecycle?​

optional lifecycle: ProviderConnectionLifecycle

Source​

-

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

+

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

name​

name: string

Source​

-

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

+

packages/extension-api/src/extension-api.d.ts:415

Methods​

status()​

@@ -47,6 +47,6 @@

Returns​

ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:418

+

packages/extension-api/src/extension-api.d.ts:418

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionEndpoint.html b/api/interfaces/KubernetesProviderConnectionEndpoint.html index 821e8433b38..498e23f82d9 100644 --- a/api/interfaces/KubernetesProviderConnectionEndpoint.html +++ b/api/interfaces/KubernetesProviderConnectionEndpoint.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:412

\ No newline at end of file diff --git a/api/interfaces/KubernetesProviderConnectionFactory.html b/api/interfaces/KubernetesProviderConnectionFactory.html index c2af5bd473e..1410bfaaa4e 100644 --- a/api/interfaces/KubernetesProviderConnectionFactory.html +++ b/api/interfaces/KubernetesProviderConnectionFactory.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: KubernetesProviderConnectionFactory

@@ -30,7 +30,7 @@

Inherited from​

ProviderConnectionFactory . creationButtonTitle

Source​

-

packages/extension-api/src/extension-api.d.ts:430

+

packages/extension-api/src/extension-api.d.ts:430

creationDisplayName?​

@@ -39,7 +39,7 @@

Inherited from​

ProviderConnectionFactory . creationDisplayName

Source​

-

packages/extension-api/src/extension-api.d.ts:427

+

packages/extension-api/src/extension-api.d.ts:427

Methods​

create()?​

@@ -52,7 +52,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:442

+

packages/extension-api/src/extension-api.d.ts:442

initialize()?​

@@ -63,6 +63,6 @@

Inherited from​

ProviderConnectionFactory . initialize

Source​

-

packages/extension-api/src/extension-api.d.ts:424

+

packages/extension-api/src/extension-api.d.ts:424

\ No newline at end of file diff --git a/api/interfaces/LifecycleContext.html b/api/interfaces/LifecycleContext.html index e0f12f0c2c6..b02e23f51e6 100644 --- a/api/interfaces/LifecycleContext.html +++ b/api/interfaces/LifecycleContext.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:339

\ No newline at end of file diff --git a/api/interfaces/Link.html b/api/interfaces/Link.html index a6404411013..d7a08280571 100644 --- a/api/interfaces/Link.html +++ b/api/interfaces/Link.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:465

\ No newline at end of file diff --git a/api/interfaces/ListImagesOptions.html b/api/interfaces/ListImagesOptions.html index 7c81187bbcd..ab726bae044 100644 --- a/api/interfaces/ListImagesOptions.html +++ b/api/interfaces/ListImagesOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3161

\ No newline at end of file diff --git a/api/interfaces/ListInfosOptions.html b/api/interfaces/ListInfosOptions.html index e7a7da839e9..f027ab94df8 100644 --- a/api/interfaces/ListInfosOptions.html +++ b/api/interfaces/ListInfosOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3265

\ No newline at end of file diff --git a/api/interfaces/Logger.html b/api/interfaces/Logger.html index d091765189a..050df6ce376 100644 --- a/api/interfaces/Logger.html +++ b/api/interfaces/Logger.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:335

\ No newline at end of file diff --git a/api/interfaces/ManifestCreateOptions.html b/api/interfaces/ManifestCreateOptions.html index c145cc073bf..ead558b137d 100644 --- a/api/interfaces/ManifestCreateOptions.html +++ b/api/interfaces/ManifestCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ManifestCreateOptions

@@ -24,34 +24,34 @@

optional all: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:387

+

packages/extension-api/src/extension-api.d.ts:387

amend?​

optional amend: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:386

+

packages/extension-api/src/extension-api.d.ts:386

images​

images: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:384

+

packages/extension-api/src/extension-api.d.ts:384

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:385

+

packages/extension-api/src/extension-api.d.ts:385

provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:390

+

packages/extension-api/src/extension-api.d.ts:390

\ No newline at end of file diff --git a/api/interfaces/ManifestInspectInfo.html b/api/interfaces/ManifestInspectInfo.html index 2d54049d93f..5e171917239 100644 --- a/api/interfaces/ManifestInspectInfo.html +++ b/api/interfaces/ManifestInspectInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ManifestInspectInfo

@@ -24,34 +24,34 @@

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:393

+

packages/extension-api/src/extension-api.d.ts:393

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:394

+

packages/extension-api/src/extension-api.d.ts:394

manifests​

manifests: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:395

+

packages/extension-api/src/extension-api.d.ts:395

mediaType​

mediaType: string

Source​

-

packages/extension-api/src/extension-api.d.ts:407

+

packages/extension-api/src/extension-api.d.ts:407

schemaVersion​

schemaVersion: number

Source​

-

packages/extension-api/src/extension-api.d.ts:408

+

packages/extension-api/src/extension-api.d.ts:408

\ No newline at end of file diff --git a/api/interfaces/MemoryStats.html b/api/interfaces/MemoryStats.html index e4e45b3817e..32a03582f53 100644 --- a/api/interfaces/MemoryStats.html +++ b/api/interfaces/MemoryStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: MemoryStats

@@ -24,42 +24,42 @@

optional commitbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2961

+

packages/extension-api/src/extension-api.d.ts:2961

commitpeakbytes?​

optional commitpeakbytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2962

+

packages/extension-api/src/extension-api.d.ts:2962

failcnt​

failcnt: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2957

+

packages/extension-api/src/extension-api.d.ts:2957

limit​

limit: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2958

+

packages/extension-api/src/extension-api.d.ts:2958

max_usage​

max_usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2955

+

packages/extension-api/src/extension-api.d.ts:2955

privateworkingset?​

optional privateworkingset: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2963

+

packages/extension-api/src/extension-api.d.ts:2963

stats​

@@ -182,13 +182,13 @@

writeback: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2924

+

packages/extension-api/src/extension-api.d.ts:2924

usage​

usage: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2956

+

packages/extension-api/src/extension-api.d.ts:2956

\ No newline at end of file diff --git a/api/interfaces/MenuItem.html b/api/interfaces/MenuItem.html index d2254d2b7d2..9b48e892962 100644 --- a/api/interfaces/MenuItem.html +++ b/api/interfaces/MenuItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: MenuItem

@@ -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 f487b6fc380..f579cd9f3fe 100644 --- a/api/interfaces/MountSettings.html +++ b/api/interfaces/MountSettings.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: MountSettings

@@ -28,42 +28,42 @@

Propagation: MountPropagation

Source​

-

packages/extension-api/src/extension-api.d.ts:2216

+

packages/extension-api/src/extension-api.d.ts:2216

Consistency?​

optional Consistency: MountConsistency

Source​

-

packages/extension-api/src/extension-api.d.ts:2214

+

packages/extension-api/src/extension-api.d.ts:2214

Mode?​

optional Mode: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2215

+

packages/extension-api/src/extension-api.d.ts:2215

ReadOnly?​

optional ReadOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2213

+

packages/extension-api/src/extension-api.d.ts:2213

Source​

Source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2211

+

packages/extension-api/src/extension-api.d.ts:2211

Target​

Target: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2210

+

packages/extension-api/src/extension-api.d.ts:2210

TmpfsOptions?​

@@ -78,14 +78,14 @@

SizeBytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2227

+

packages/extension-api/src/extension-api.d.ts:2227

Type​

Type: MountType

Source​

-

packages/extension-api/src/extension-api.d.ts:2212

+

packages/extension-api/src/extension-api.d.ts:2212

VolumeOptions?​

@@ -116,6 +116,6 @@

NoCopy: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2219

+

packages/extension-api/src/extension-api.d.ts:2219

\ No newline at end of file diff --git a/api/interfaces/NetworkContainer.html b/api/interfaces/NetworkContainer.html index 99b69874d2a..deae6cecc57 100644 --- a/api/interfaces/NetworkContainer.html +++ b/api/interfaces/NetworkContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: NetworkContainer

@@ -24,34 +24,34 @@

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2066

+

packages/extension-api/src/extension-api.d.ts:2066

IPv4Address​

IPv4Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2068

+

packages/extension-api/src/extension-api.d.ts:2068

IPv6Address​

IPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2069

+

packages/extension-api/src/extension-api.d.ts:2069

MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2067

+

packages/extension-api/src/extension-api.d.ts:2067

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2065

+

packages/extension-api/src/extension-api.d.ts:2065

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateOptions.html b/api/interfaces/NetworkCreateOptions.html index ef1657e3cb9..f427cb0fce5 100644 --- a/api/interfaces/NetworkCreateOptions.html +++ b/api/interfaces/NetworkCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3165

\ No newline at end of file diff --git a/api/interfaces/NetworkCreateResult.html b/api/interfaces/NetworkCreateResult.html index f51e5107e11..7f9b40a1439 100644 --- a/api/interfaces/NetworkCreateResult.html +++ b/api/interfaces/NetworkCreateResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3169

\ No newline at end of file diff --git a/api/interfaces/NetworkInfo.html b/api/interfaces/NetworkInfo.html index af78b8fd127..fc473bb7246 100644 --- a/api/interfaces/NetworkInfo.html +++ b/api/interfaces/NetworkInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: NetworkInfo

@@ -24,83 +24,83 @@

optional Aliases: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2141

+

packages/extension-api/src/extension-api.d.ts:2141

EndpointID​

EndpointID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2143

+

packages/extension-api/src/extension-api.d.ts:2143

Gateway​

Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2144

+

packages/extension-api/src/extension-api.d.ts:2144

GlobalIPv6Address​

GlobalIPv6Address: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2148

+

packages/extension-api/src/extension-api.d.ts:2148

GlobalIPv6PrefixLen​

GlobalIPv6PrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2149

+

packages/extension-api/src/extension-api.d.ts:2149

IPAMConfig?​

optional IPAMConfig: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2139

+

packages/extension-api/src/extension-api.d.ts:2139

IPAddress​

IPAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2145

+

packages/extension-api/src/extension-api.d.ts:2145

IPPrefixLen​

IPPrefixLen: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2146

+

packages/extension-api/src/extension-api.d.ts:2146

IPv6Gateway​

IPv6Gateway: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2147

+

packages/extension-api/src/extension-api.d.ts:2147

optional Links: unknown

Source​

-

packages/extension-api/src/extension-api.d.ts:2140

+

packages/extension-api/src/extension-api.d.ts:2140

MacAddress​

MacAddress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2150

+

packages/extension-api/src/extension-api.d.ts:2150

NetworkID​

NetworkID: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2142

+

packages/extension-api/src/extension-api.d.ts:2142

\ No newline at end of file diff --git a/api/interfaces/NetworkInspectInfo.html b/api/interfaces/NetworkInspectInfo.html index b38bec1336c..c062b7ae5e2 100644 --- a/api/interfaces/NetworkInspectInfo.html +++ b/api/interfaces/NetworkInspectInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: NetworkInspectInfo

@@ -24,7 +24,7 @@

Attachable: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2090

+

packages/extension-api/src/extension-api.d.ts:2090

ConfigFrom?​

@@ -35,14 +35,14 @@

Network: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2092

+

packages/extension-api/src/extension-api.d.ts:2092

ConfigOnly​

ConfigOnly: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2093

+

packages/extension-api/src/extension-api.d.ts:2093

Containers?​

@@ -51,56 +51,56 @@

Index signature​

[id: string]: NetworkContainer

Source​

-

packages/extension-api/src/extension-api.d.ts:2094

+

packages/extension-api/src/extension-api.d.ts:2094

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2084

+

packages/extension-api/src/extension-api.d.ts:2084

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2086

+

packages/extension-api/src/extension-api.d.ts:2086

EnableIPv6​

EnableIPv6: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2087

+

packages/extension-api/src/extension-api.d.ts:2087

IPAM?​

optional IPAM: IPAM

Source​

-

packages/extension-api/src/extension-api.d.ts:2088

+

packages/extension-api/src/extension-api.d.ts:2088

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2083

+

packages/extension-api/src/extension-api.d.ts:2083

Ingress​

Ingress: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2091

+

packages/extension-api/src/extension-api.d.ts:2091

Internal​

Internal: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:2089

+

packages/extension-api/src/extension-api.d.ts:2089

Labels?​

@@ -109,14 +109,14 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2096

+

packages/extension-api/src/extension-api.d.ts:2096

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2082

+

packages/extension-api/src/extension-api.d.ts:2082

Options?​

@@ -125,34 +125,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2095

+

packages/extension-api/src/extension-api.d.ts:2095

Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2085

+

packages/extension-api/src/extension-api.d.ts:2085

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2079

+

packages/extension-api/src/extension-api.d.ts:2079

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2080

+

packages/extension-api/src/extension-api.d.ts:2080

engineType​

engineType: "docker" | "podman"

Source​

-

packages/extension-api/src/extension-api.d.ts:2081

+

packages/extension-api/src/extension-api.d.ts:2081

\ No newline at end of file diff --git a/api/interfaces/NetworkStats.html b/api/interfaces/NetworkStats.html index 2cfc7dbcbdb..5a6aadc5e16 100644 --- a/api/interfaces/NetworkStats.html +++ b/api/interfaces/NetworkStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: NetworkStats

diff --git a/api/interfaces/NetworkingConfig.html b/api/interfaces/NetworkingConfig.html index b9fe72e8865..bb9efac8404 100644 --- a/api/interfaces/NetworkingConfig.html +++ b/api/interfaces/NetworkingConfig.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:2650

\ No newline at end of file diff --git a/api/interfaces/NotificationOptions.html b/api/interfaces/NotificationOptions.html index b9028066491..360223b73cf 100644 --- a/api/interfaces/NotificationOptions.html +++ b/api/interfaces/NotificationOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: NotificationOptions

@@ -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:1274

+

packages/extension-api/src/extension-api.d.ts:1274

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:1290

+

packages/extension-api/src/extension-api.d.ts:1290

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:1286

+

packages/extension-api/src/extension-api.d.ts:1286

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:1278

+

packages/extension-api/src/extension-api.d.ts:1278

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:1270

+

packages/extension-api/src/extension-api.d.ts:1270

type?​

@@ -65,6 +65,6 @@

The type of the notification. Default value: info

Source​

-

packages/extension-api/src/extension-api.d.ts:1282

+

packages/extension-api/src/extension-api.d.ts:1282

\ No newline at end of file diff --git a/api/interfaces/OpenDialogOptions.html b/api/interfaces/OpenDialogOptions.html index c25bb9750dc..fd440a08648 100644 --- a/api/interfaces/OpenDialogOptions.html +++ b/api/interfaces/OpenDialogOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: OpenDialogOptions

@@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1632

+

packages/extension-api/src/extension-api.d.ts:1632

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:1648

+

packages/extension-api/src/extension-api.d.ts:1648

openLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the open button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1637

+

packages/extension-api/src/extension-api.d.ts:1637

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:1643

+

packages/extension-api/src/extension-api.d.ts:1643

title?​

@@ -59,6 +59,6 @@ supported:

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1656

+

packages/extension-api/src/extension-api.d.ts:1656

\ No newline at end of file diff --git a/api/interfaces/PidsStats.html b/api/interfaces/PidsStats.html index 7a510f47679..e05d56c2e36 100644 --- a/api/interfaces/PidsStats.html +++ b/api/interfaces/PidsStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2879

\ No newline at end of file diff --git a/api/interfaces/PodContainerInfo.html b/api/interfaces/PodContainerInfo.html index 48320197fd1..546030f2cd4 100644 --- a/api/interfaces/PodContainerInfo.html +++ b/api/interfaces/PodContainerInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2156

\ No newline at end of file diff --git a/api/interfaces/PodCreateOptions.html b/api/interfaces/PodCreateOptions.html index 5d2f92541f9..efbe3e1920b 100644 --- a/api/interfaces/PodCreateOptions.html +++ b/api/interfaces/PodCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PodCreateOptions

@@ -26,27 +26,27 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:378

+

packages/extension-api/src/extension-api.d.ts:378

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:376

+

packages/extension-api/src/extension-api.d.ts:376

portmappings?​

optional portmappings: PodCreatePortOptions[]

Source​

-

packages/extension-api/src/extension-api.d.ts:377

+

packages/extension-api/src/extension-api.d.ts:377

provider?​

optional provider: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:380

+

packages/extension-api/src/extension-api.d.ts:380

\ No newline at end of file diff --git a/api/interfaces/PodCreatePortOptions.html b/api/interfaces/PodCreatePortOptions.html index d52ddef4767..a963911a2c9 100644 --- a/api/interfaces/PodCreatePortOptions.html +++ b/api/interfaces/PodCreatePortOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PodCreatePortOptions

@@ -24,34 +24,34 @@

container_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:369

+

packages/extension-api/src/extension-api.d.ts:369

host_ip​

host_ip: string

Source​

-

packages/extension-api/src/extension-api.d.ts:368

+

packages/extension-api/src/extension-api.d.ts:368

host_port​

host_port: number

Source​

-

packages/extension-api/src/extension-api.d.ts:370

+

packages/extension-api/src/extension-api.d.ts:370

protocol​

protocol: string

Source​

-

packages/extension-api/src/extension-api.d.ts:371

+

packages/extension-api/src/extension-api.d.ts:371

range​

range: number

Source​

-

packages/extension-api/src/extension-api.d.ts:372

+

packages/extension-api/src/extension-api.d.ts:372

\ No newline at end of file diff --git a/api/interfaces/PodInfo.html b/api/interfaces/PodInfo.html index fff9781b967..7a48f75acdd 100644 --- a/api/interfaces/PodInfo.html +++ b/api/interfaces/PodInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PodInfo

@@ -24,35 +24,35 @@

Cgroup: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2163

+

packages/extension-api/src/extension-api.d.ts:2163

Containers​

Containers: PodContainerInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2164

+

packages/extension-api/src/extension-api.d.ts:2164

Created​

Created: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2165

+

packages/extension-api/src/extension-api.d.ts:2165

Id​

Id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2166

+

packages/extension-api/src/extension-api.d.ts:2166

InfraId​

InfraId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2167

+

packages/extension-api/src/extension-api.d.ts:2167

Labels​

@@ -61,55 +61,55 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2168

+

packages/extension-api/src/extension-api.d.ts:2168

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2169

+

packages/extension-api/src/extension-api.d.ts:2169

Namespace​

Namespace: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2170

+

packages/extension-api/src/extension-api.d.ts:2170

Networks​

Networks: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2171

+

packages/extension-api/src/extension-api.d.ts:2171

Status​

Status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2172

+

packages/extension-api/src/extension-api.d.ts:2172

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2160

+

packages/extension-api/src/extension-api.d.ts:2160

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2161

+

packages/extension-api/src/extension-api.d.ts:2161

kind​

kind: "podman" | "kubernetes"

Source​

-

packages/extension-api/src/extension-api.d.ts:2162

+

packages/extension-api/src/extension-api.d.ts:2162

\ No newline at end of file diff --git a/api/interfaces/PodmanContainerCreateOptions.html b/api/interfaces/PodmanContainerCreateOptions.html index f5c1e209e1b..647874513c5 100644 --- a/api/interfaces/PodmanContainerCreateOptions.html +++ b/api/interfaces/PodmanContainerCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PodmanContainerCreateOptions

@@ -24,14 +24,14 @@

optional command: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2654

+

packages/extension-api/src/extension-api.d.ts:2654

entrypoint?​

optional entrypoint: string | string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2655

+

packages/extension-api/src/extension-api.d.ts:2655

env?​

@@ -40,41 +40,41 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2656

+

packages/extension-api/src/extension-api.d.ts:2656

hostname?​

optional hostname: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2658

+

packages/extension-api/src/extension-api.d.ts:2658

image?​

optional image: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2659

+

packages/extension-api/src/extension-api.d.ts:2659

mounts?​

optional mounts: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:2661

+

packages/extension-api/src/extension-api.d.ts:2661

name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2660

+

packages/extension-api/src/extension-api.d.ts:2660

pod?​

optional pod: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2657

+

packages/extension-api/src/extension-api.d.ts:2657

\ No newline at end of file diff --git a/api/interfaces/Port.html b/api/interfaces/Port.html index 657c005fa2d..2532b54e99f 100644 --- a/api/interfaces/Port.html +++ b/api/interfaces/Port.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Port

@@ -24,27 +24,27 @@

IP: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2132

+

packages/extension-api/src/extension-api.d.ts:2132

PrivatePort​

PrivatePort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2133

+

packages/extension-api/src/extension-api.d.ts:2133

PublicPort​

PublicPort: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2134

+

packages/extension-api/src/extension-api.d.ts:2134

Type​

Type: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2135

+

packages/extension-api/src/extension-api.d.ts:2135

\ No newline at end of file diff --git a/api/interfaces/PortBinding.html b/api/interfaces/PortBinding.html index ebc7f16183c..0396c422e36 100644 --- a/api/interfaces/PortBinding.html +++ b/api/interfaces/PortBinding.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2191

\ No newline at end of file diff --git a/api/interfaces/PortMap.html b/api/interfaces/PortMap.html index 4ac92a3e8e6..b1b5300f9e4 100644 --- a/api/interfaces/PortMap.html +++ b/api/interfaces/PortMap.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PortMap

diff --git a/api/interfaces/Progress.html b/api/interfaces/Progress.html index 8acb70ef3df..83ff3aaf95d 100644 --- a/api/interfaces/Progress.html +++ b/api/interfaces/Progress.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:841

\ No newline at end of file diff --git a/api/interfaces/ProgressOptions.html b/api/interfaces/ProgressOptions.html index 0eba382a373..170631c554b 100644 --- a/api/interfaces/ProgressOptions.html +++ b/api/interfaces/ProgressOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProgressOptions

@@ -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:885

+

packages/extension-api/src/extension-api.d.ts:885

location​

@@ -37,7 +37,7 @@ button.

The location at which progress should show.

Source​

-

packages/extension-api/src/extension-api.d.ts:871

+

packages/extension-api/src/extension-api.d.ts:871

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:877

+

packages/extension-api/src/extension-api.d.ts:877

\ No newline at end of file diff --git a/api/interfaces/Provider.html b/api/interfaces/Provider.html index 71f5ecc527f..c108f8273c8 100644 --- a/api/interfaces/Provider.html +++ b/api/interfaces/Provider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Provider

@@ -24,77 +24,77 @@

readonly detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:581

+

packages/extension-api/src/extension-api.d.ts:581

id​

readonly id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:566

+

packages/extension-api/src/extension-api.d.ts:566

images​

readonly images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:576

+

packages/extension-api/src/extension-api.d.ts:576

readonly links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:578

+

packages/extension-api/src/extension-api.d.ts:578

name​

readonly name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:565

+

packages/extension-api/src/extension-api.d.ts:565

onDidUpdateDetectionChecks​

onDidUpdateDetectionChecks: Event <ProviderDetectionCheck[]>

Source​

-

packages/extension-api/src/extension-api.d.ts:592

+

packages/extension-api/src/extension-api.d.ts:592

onDidUpdateStatus​

onDidUpdateStatus: Event <ProviderStatus>

Source​

-

packages/extension-api/src/extension-api.d.ts:569

+

packages/extension-api/src/extension-api.d.ts:569

onDidUpdateVersion​

onDidUpdateVersion: Event<string>

Source​

-

packages/extension-api/src/extension-api.d.ts:574

+

packages/extension-api/src/extension-api.d.ts:574

status​

readonly status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:567

+

packages/extension-api/src/extension-api.d.ts:567

version​

readonly version: undefined | string

Source​

-

packages/extension-api/src/extension-api.d.ts:572

+

packages/extension-api/src/extension-api.d.ts:572

warnings​

readonly warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:588

+

packages/extension-api/src/extension-api.d.ts:588

Methods​

dispose()​

@@ -103,7 +103,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:564

+

packages/extension-api/src/extension-api.d.ts:564

registerAutostart()​

@@ -114,7 +114,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:560

+

packages/extension-api/src/extension-api.d.ts:560

registerCleanup()​

@@ -125,7 +125,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:562

+

packages/extension-api/src/extension-api.d.ts:562

registerContainerProviderConnection()​

@@ -136,7 +136,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:549

+

packages/extension-api/src/extension-api.d.ts:549

registerInstallation()​

@@ -147,7 +147,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:554

+

packages/extension-api/src/extension-api.d.ts:554

registerKubernetesProviderConnection()​

@@ -158,7 +158,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:550

+

packages/extension-api/src/extension-api.d.ts:550

registerLifecycle()​

@@ -169,7 +169,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:551

+

packages/extension-api/src/extension-api.d.ts:551

registerUpdate()​

@@ -180,7 +180,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:557

+

packages/extension-api/src/extension-api.d.ts:557

setContainerProviderConnectionFactory()​

@@ -192,7 +192,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:540

+

packages/extension-api/src/extension-api.d.ts:540

setKubernetesProviderConnectionFactory()​

@@ -204,7 +204,7 @@

Returns​

Disposable

Source​

-

packages/extension-api/src/extension-api.d.ts:544

+

packages/extension-api/src/extension-api.d.ts:544

updateDetectionChecks()​

@@ -215,7 +215,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:585

+

packages/extension-api/src/extension-api.d.ts:585

updateStatus()​

@@ -226,7 +226,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:568

+

packages/extension-api/src/extension-api.d.ts:568

updateVersion()​

@@ -237,7 +237,7 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:573

+

packages/extension-api/src/extension-api.d.ts:573

updateWarnings()​

@@ -248,6 +248,6 @@

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:589

+

packages/extension-api/src/extension-api.d.ts:589

\ No newline at end of file diff --git a/api/interfaces/ProviderAutostart.html b/api/interfaces/ProviderAutostart.html index 62687317681..0b2004a8ff8 100644 --- a/api/interfaces/ProviderAutostart.html +++ b/api/interfaces/ProviderAutostart.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:509

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanup.html b/api/interfaces/ProviderCleanup.html index 44d87e4956d..38f076ad8d0 100644 --- a/api/interfaces/ProviderCleanup.html +++ b/api/interfaces/ProviderCleanup.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:516

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupAction.html b/api/interfaces/ProviderCleanupAction.html index 8d38dcb7d48..8cd6c7444e5 100644 --- a/api/interfaces/ProviderCleanupAction.html +++ b/api/interfaces/ProviderCleanupAction.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:529

\ No newline at end of file diff --git a/api/interfaces/ProviderCleanupExecuteOptions.html b/api/interfaces/ProviderCleanupExecuteOptions.html index 6c4ea94c6c7..cdc4caf1865 100644 --- a/api/interfaces/ProviderCleanupExecuteOptions.html +++ b/api/interfaces/ProviderCleanupExecuteOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:521

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionFactory.html b/api/interfaces/ProviderConnectionFactory.html index 7d6038104ee..8c0f3712d07 100644 --- a/api/interfaces/ProviderConnectionFactory.html +++ b/api/interfaces/ProviderConnectionFactory.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProviderConnectionFactory

@@ -29,14 +29,14 @@

optional creationButtonTitle: string

Source​

-

packages/extension-api/src/extension-api.d.ts:430

+

packages/extension-api/src/extension-api.d.ts:430

creationDisplayName?​

optional creationDisplayName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:427

+

packages/extension-api/src/extension-api.d.ts:427

Methods​

initialize()?​

@@ -45,6 +45,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:424

+

packages/extension-api/src/extension-api.d.ts:424

\ No newline at end of file diff --git a/api/interfaces/ProviderConnectionLifecycle.html b/api/interfaces/ProviderConnectionLifecycle.html index f897a4a509b..65ea6543a8a 100644 --- a/api/interfaces/ProviderConnectionLifecycle.html +++ b/api/interfaces/ProviderConnectionLifecycle.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProviderConnectionLifecycle

@@ -28,7 +28,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:345

+

packages/extension-api/src/extension-api.d.ts:345

edit()?​

@@ -42,7 +42,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:346

+

packages/extension-api/src/extension-api.d.ts:346

start()?​

@@ -54,7 +54,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:343

+

packages/extension-api/src/extension-api.d.ts:343

stop()?​

@@ -66,6 +66,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:344

+

packages/extension-api/src/extension-api.d.ts:344

\ No newline at end of file diff --git a/api/interfaces/ProviderContainerConnection.html b/api/interfaces/ProviderContainerConnection.html index 25eb7d2d175..192fd3c9be4 100644 --- a/api/interfaces/ProviderContainerConnection.html +++ b/api/interfaces/ProviderContainerConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:653

\ No newline at end of file diff --git a/api/interfaces/ProviderDetectionCheck.html b/api/interfaces/ProviderDetectionCheck.html index 7f7331d3cc0..1b4c995282c 100644 --- a/api/interfaces/ProviderDetectionCheck.html +++ b/api/interfaces/ProviderDetectionCheck.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:308

\ No newline at end of file diff --git a/api/interfaces/ProviderEvent.html b/api/interfaces/ProviderEvent.html index 34403d35c62..4b19f3664a7 100644 --- a/api/interfaces/ProviderEvent.html +++ b/api/interfaces/ProviderEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:624

\ No newline at end of file diff --git a/api/interfaces/ProviderImages.html b/api/interfaces/ProviderImages.html index eacfff5320b..56fb26dcf9b 100644 --- a/api/interfaces/ProviderImages.html +++ b/api/interfaces/ProviderImages.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:536

\ No newline at end of file diff --git a/api/interfaces/ProviderInformation.html b/api/interfaces/ProviderInformation.html index 8b748327a58..e3e59792678 100644 --- a/api/interfaces/ProviderInformation.html +++ b/api/interfaces/ProviderInformation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:301

\ No newline at end of file diff --git a/api/interfaces/ProviderInstallation.html b/api/interfaces/ProviderInstallation.html index 02e11c6a04b..d5dd4a59453 100644 --- a/api/interfaces/ProviderInstallation.html +++ b/api/interfaces/ProviderInstallation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:490

\ No newline at end of file diff --git a/api/interfaces/ProviderLifecycle.html b/api/interfaces/ProviderLifecycle.html index fda853e3373..45069678eb3 100644 --- a/api/interfaces/ProviderLifecycle.html +++ b/api/interfaces/ProviderLifecycle.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProviderLifecycle

@@ -28,7 +28,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:292

+

packages/extension-api/src/extension-api.d.ts:292

start()​

@@ -39,7 +39,7 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:293

+

packages/extension-api/src/extension-api.d.ts:293

status()​

@@ -48,7 +48,7 @@

Returns​

ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:295

+

packages/extension-api/src/extension-api.d.ts:295

stop()​

@@ -59,6 +59,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:294

+

packages/extension-api/src/extension-api.d.ts:294

\ No newline at end of file diff --git a/api/interfaces/ProviderOptions.html b/api/interfaces/ProviderOptions.html index f2cd953af9b..114f7002c73 100644 --- a/api/interfaces/ProviderOptions.html +++ b/api/interfaces/ProviderOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProviderOptions

@@ -24,62 +24,62 @@

optional detectionChecks: ProviderDetectionCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:318

+

packages/extension-api/src/extension-api.d.ts:318

emptyConnectionMarkdownDescription?​

optional emptyConnectionMarkdownDescription: string

Source​

-

packages/extension-api/src/extension-api.d.ts:324

+

packages/extension-api/src/extension-api.d.ts:324

id​

id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:312

+

packages/extension-api/src/extension-api.d.ts:312

images?​

optional images: ProviderImages

Source​

-

packages/extension-api/src/extension-api.d.ts:316

+

packages/extension-api/src/extension-api.d.ts:316

optional links: Link[]

Source​

-

packages/extension-api/src/extension-api.d.ts:317

+

packages/extension-api/src/extension-api.d.ts:317

name​

name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:313

+

packages/extension-api/src/extension-api.d.ts:313

status​

status: ProviderStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:314

+

packages/extension-api/src/extension-api.d.ts:314

version?​

optional version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:315

+

packages/extension-api/src/extension-api.d.ts:315

warnings?​

optional warnings: ProviderInformation[]

Source​

-

packages/extension-api/src/extension-api.d.ts:321

+

packages/extension-api/src/extension-api.d.ts:321

\ No newline at end of file diff --git a/api/interfaces/ProviderUpdate.html b/api/interfaces/ProviderUpdate.html index b4ac07ccb01..4a67d35c169 100644 --- a/api/interfaces/ProviderUpdate.html +++ b/api/interfaces/ProviderUpdate.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: ProviderUpdate

@@ -24,7 +24,7 @@

version: string

Source​

-

packages/extension-api/src/extension-api.d.ts:496

+

packages/extension-api/src/extension-api.d.ts:496

Methods​

preflightChecks()?​

@@ -33,7 +33,7 @@

Returns​

InstallCheck[]

Source​

-

packages/extension-api/src/extension-api.d.ts:500

+

packages/extension-api/src/extension-api.d.ts:500

update()​

@@ -44,6 +44,6 @@

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:498

+

packages/extension-api/src/extension-api.d.ts:498

\ No newline at end of file diff --git a/api/interfaces/ProxySettings.html b/api/interfaces/ProxySettings.html index a4de75937af..278a9d8738b 100644 --- a/api/interfaces/ProxySettings.html +++ b/api/interfaces/ProxySettings.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:683

\ No newline at end of file diff --git a/api/interfaces/PullEvent.html b/api/interfaces/PullEvent.html index aef0e805d6c..31922be4e0d 100644 --- a/api/interfaces/PullEvent.html +++ b/api/interfaces/PullEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: PullEvent

@@ -24,7 +24,7 @@

optional error: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2504

+

packages/extension-api/src/extension-api.d.ts:2504

errorDetails?​

@@ -35,21 +35,21 @@

optional message: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2505

+

packages/extension-api/src/extension-api.d.ts:2505

id?​

optional id: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2497

+

packages/extension-api/src/extension-api.d.ts:2497

progress?​

optional progress: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2499

+

packages/extension-api/src/extension-api.d.ts:2499

progressDetail?​

@@ -64,20 +64,20 @@

optional total: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2500

+

packages/extension-api/src/extension-api.d.ts:2500

status?​

optional status: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2498

+

packages/extension-api/src/extension-api.d.ts:2498

stream?​

optional stream: string

Source​

-

packages/extension-api/src/extension-api.d.ts:2496

+

packages/extension-api/src/extension-api.d.ts:2496

\ No newline at end of file diff --git a/api/interfaces/QuickInputButton.html b/api/interfaces/QuickInputButton.html index b320fb7f61f..9291287ec76 100644 --- a/api/interfaces/QuickInputButton.html +++ b/api/interfaces/QuickInputButton.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1046

\ No newline at end of file diff --git a/api/interfaces/QuickPickItem.html b/api/interfaces/QuickPickItem.html index 8108739bb61..9c94e3bc8c8 100644 --- a/api/interfaces/QuickPickItem.html +++ b/api/interfaces/QuickPickItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: QuickPickItem

@@ -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:1142

+

packages/extension-api/src/extension-api.d.ts:1142

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:1152

+

packages/extension-api/src/extension-api.d.ts:1152

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:1114

+

packages/extension-api/src/extension-api.d.ts:1114

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:1122

+

packages/extension-api/src/extension-api.d.ts:1122

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:1106

+

packages/extension-api/src/extension-api.d.ts:1106

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:1100

+

packages/extension-api/src/extension-api.d.ts:1100

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:1135

+

packages/extension-api/src/extension-api.d.ts:1135

\ No newline at end of file diff --git a/api/interfaces/QuickPickOptions.html b/api/interfaces/QuickPickOptions.html index c4934abcd08..182bb84aca6 100644 --- a/api/interfaces/QuickPickOptions.html +++ b/api/interfaces/QuickPickOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: QuickPickOptions

@@ -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:1082

+

packages/extension-api/src/extension-api.d.ts:1082

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:1077

+

packages/extension-api/src/extension-api.d.ts:1077

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:1061

+

packages/extension-api/src/extension-api.d.ts:1061

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:1066

+

packages/extension-api/src/extension-api.d.ts:1066

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:1071

+

packages/extension-api/src/extension-api.d.ts:1071

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:1056

+

packages/extension-api/src/extension-api.d.ts:1056

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:1088

+

packages/extension-api/src/extension-api.d.ts:1088

\ No newline at end of file diff --git a/api/interfaces/RegisterContainerConnectionEvent.html b/api/interfaces/RegisterContainerConnectionEvent.html index 9f1a303e34d..0fab3c9ab25 100644 --- a/api/interfaces/RegisterContainerConnectionEvent.html +++ b/api/interfaces/RegisterContainerConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:649

\ No newline at end of file diff --git a/api/interfaces/RegisterKubernetesConnectionEvent.html b/api/interfaces/RegisterKubernetesConnectionEvent.html index b9291d17a79..5732f8da9f6 100644 --- a/api/interfaces/RegisterKubernetesConnectionEvent.html +++ b/api/interfaces/RegisterKubernetesConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:646

\ No newline at end of file diff --git a/api/interfaces/Registry.html b/api/interfaces/Registry.html index a3374da0810..e45e08ad906 100644 --- a/api/interfaces/Registry.html +++ b/api/interfaces/Registry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Registry

@@ -30,14 +30,14 @@

Inherited from​

RegistryCreateOptions . alias

Source​

-

packages/extension-api/src/extension-api.d.ts:721

+

packages/extension-api/src/extension-api.d.ts:721

icon?​

optional icon: string

Source​

-

packages/extension-api/src/extension-api.d.ts:713

+

packages/extension-api/src/extension-api.d.ts:713

insecure?​

@@ -46,14 +46,14 @@

Inherited from​

RegistryCreateOptions . insecure

Source​

-

packages/extension-api/src/extension-api.d.ts:720

+

packages/extension-api/src/extension-api.d.ts:720

name?​

optional name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:712

+

packages/extension-api/src/extension-api.d.ts:712

secret​

@@ -62,7 +62,7 @@

Inherited from​

RegistryCreateOptions . secret

Source​

-

packages/extension-api/src/extension-api.d.ts:719

+

packages/extension-api/src/extension-api.d.ts:719

serverUrl​

@@ -71,14 +71,14 @@

Inherited from​

RegistryCreateOptions . serverUrl

Source​

-

packages/extension-api/src/extension-api.d.ts:717

+

packages/extension-api/src/extension-api.d.ts:717

source​

source: string

Source​

-

packages/extension-api/src/extension-api.d.ts:709

+

packages/extension-api/src/extension-api.d.ts:709

username​

@@ -87,6 +87,6 @@

Inherited from​

RegistryCreateOptions . username

Source​

-

packages/extension-api/src/extension-api.d.ts:718

+

packages/extension-api/src/extension-api.d.ts:718

\ No newline at end of file diff --git a/api/interfaces/RegistryConfig.html b/api/interfaces/RegistryConfig.html index b9b12f1b6f1..6db77082be3 100644 --- a/api/interfaces/RegistryConfig.html +++ b/api/interfaces/RegistryConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: RegistryConfig

diff --git a/api/interfaces/RegistryCreateOptions.html b/api/interfaces/RegistryCreateOptions.html index d9ac2d3fd8a..11e3dc63ea4 100644 --- a/api/interfaces/RegistryCreateOptions.html +++ b/api/interfaces/RegistryCreateOptions.html @@ -13,8 +13,8 @@ - - + +

Interface: RegistryCreateOptions

@@ -28,34 +28,34 @@

optional alias: string

Source​

-

packages/extension-api/src/extension-api.d.ts:721

+

packages/extension-api/src/extension-api.d.ts:721

insecure?​

optional insecure: boolean

Source​

-

packages/extension-api/src/extension-api.d.ts:720

+

packages/extension-api/src/extension-api.d.ts:720

secret​

secret: string

Source​

-

packages/extension-api/src/extension-api.d.ts:719

+

packages/extension-api/src/extension-api.d.ts:719

serverUrl​

serverUrl: string

Source​

-

packages/extension-api/src/extension-api.d.ts:717

+

packages/extension-api/src/extension-api.d.ts:717

username​

username: string

Source​

-

packages/extension-api/src/extension-api.d.ts:718

+

packages/extension-api/src/extension-api.d.ts:718

\ No newline at end of file diff --git a/api/interfaces/RegistryProvider.html b/api/interfaces/RegistryProvider.html index 66b991a2414..332a2d9136e 100644 --- a/api/interfaces/RegistryProvider.html +++ b/api/interfaces/RegistryProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:726

\ No newline at end of file diff --git a/api/interfaces/RegistrySuggestedProvider.html b/api/interfaces/RegistrySuggestedProvider.html index 1edb6f751cd..6dbe9ca68c3 100644 --- a/api/interfaces/RegistrySuggestedProvider.html +++ b/api/interfaces/RegistrySuggestedProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:702

\ No newline at end of file diff --git a/api/interfaces/RunError.html b/api/interfaces/RunError.html index 2049ada30b3..9ae7f98899d 100644 --- a/api/interfaces/RunError.html +++ b/api/interfaces/RunError.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: RunError

@@ -30,7 +30,7 @@

Indicates whether the execution was cancelled.

Source​

-

packages/extension-api/src/extension-api.d.ts:3927

+

packages/extension-api/src/extension-api.d.ts:3927

cause?​

@@ -47,7 +47,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3912

+

packages/extension-api/src/extension-api.d.ts:3912

exitCode​

@@ -55,7 +55,7 @@

The exit code of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3907

+

packages/extension-api/src/extension-api.d.ts:3907

killed​

@@ -63,7 +63,7 @@

Indicates whether the process was forcefully killed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3932

+

packages/extension-api/src/extension-api.d.ts:3932

message​

@@ -73,7 +73,7 @@

Overrides​

Error.message

Source​

-

packages/extension-api/src/extension-api.d.ts:3902

+

packages/extension-api/src/extension-api.d.ts:3902

name​

@@ -99,7 +99,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3922

+

packages/extension-api/src/extension-api.d.ts:3922

stdout​

@@ -107,6 +107,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3917

+

packages/extension-api/src/extension-api.d.ts:3917

\ No newline at end of file diff --git a/api/interfaces/RunOptions.html b/api/interfaces/RunOptions.html index 8e0bd6a58d0..a04e4607d13 100644 --- a/api/interfaces/RunOptions.html +++ b/api/interfaces/RunOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: RunOptions

@@ -26,7 +26,7 @@

custom directory

Source​

-

packages/extension-api/src/extension-api.d.ts:3862

+

packages/extension-api/src/extension-api.d.ts:3862

encoding?​

@@ -34,7 +34,7 @@

The encoding to use. Default utf8

Source​

-

packages/extension-api/src/extension-api.d.ts:3872

+

packages/extension-api/src/extension-api.d.ts:3872

env?​

@@ -44,7 +44,7 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3847

+

packages/extension-api/src/extension-api.d.ts:3847

isAdmin?​

@@ -52,7 +52,7 @@

admin privileges required

Source​

-

packages/extension-api/src/extension-api.d.ts:3867

+

packages/extension-api/src/extension-api.d.ts:3867

logger?​

@@ -60,7 +60,7 @@

A logger used to track execution events.

Source​

-

packages/extension-api/src/extension-api.d.ts:3857

+

packages/extension-api/src/extension-api.d.ts:3857

token?​

@@ -68,6 +68,6 @@

A cancellation token used to request cancellation.

Source​

-

packages/extension-api/src/extension-api.d.ts:3852

+

packages/extension-api/src/extension-api.d.ts:3852

\ No newline at end of file diff --git a/api/interfaces/RunResult.html b/api/interfaces/RunResult.html index 1be34a7c4f6..66d055164e1 100644 --- a/api/interfaces/RunResult.html +++ b/api/interfaces/RunResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: RunResult

@@ -26,7 +26,7 @@

The command that was executed.

Source​

-

packages/extension-api/src/extension-api.d.ts:3882

+

packages/extension-api/src/extension-api.d.ts:3882

stderr​

@@ -34,7 +34,7 @@

The standard error (stderr) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3892

+

packages/extension-api/src/extension-api.d.ts:3892

stdout​

@@ -42,6 +42,6 @@

The standard output (stdout) content of the command.

Source​

-

packages/extension-api/src/extension-api.d.ts:3887

+

packages/extension-api/src/extension-api.d.ts:3887

\ No newline at end of file diff --git a/api/interfaces/SaveDialogOptions.html b/api/interfaces/SaveDialogOptions.html index 6624d2b166b..ace2ee001c8 100644 --- a/api/interfaces/SaveDialogOptions.html +++ b/api/interfaces/SaveDialogOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: SaveDialogOptions

@@ -26,7 +26,7 @@

The resource the dialog shows when opened.

Source​

-

packages/extension-api/src/extension-api.d.ts:1666

+

packages/extension-api/src/extension-api.d.ts:1666

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:1676

+

packages/extension-api/src/extension-api.d.ts:1676

saveLabel?​

@@ -42,7 +42,7 @@

A human-readable string for the save button.

Source​

-

packages/extension-api/src/extension-api.d.ts:1671

+

packages/extension-api/src/extension-api.d.ts:1671

title?​

@@ -50,6 +50,6 @@

Dialog title.

Source​

-

packages/extension-api/src/extension-api.d.ts:1684

+

packages/extension-api/src/extension-api.d.ts:1684

\ No newline at end of file diff --git a/api/interfaces/SecretStorage.html b/api/interfaces/SecretStorage.html index a86e5a974ad..ce4625bb84e 100644 --- a/api/interfaces/SecretStorage.html +++ b/api/interfaces/SecretStorage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: SecretStorage

@@ -27,7 +27,7 @@ sensitive.

Fires when a secret is stored or deleted.

Source​

-

packages/extension-api/src/extension-api.d.ts:4352

+

packages/extension-api/src/extension-api.d.ts:4352

Methods​

delete()​

@@ -40,7 +40,7 @@ sensitive.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4347

+

packages/extension-api/src/extension-api.d.ts:4347

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:4334

+

packages/extension-api/src/extension-api.d.ts:4334

store()​

@@ -70,6 +70,6 @@ is no secret matching that key.

Returns​

Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4341

+

packages/extension-api/src/extension-api.d.ts:4341

\ No newline at end of file diff --git a/api/interfaces/SecretStorageChangeEvent.html b/api/interfaces/SecretStorageChangeEvent.html index 14f427db33b..d813a650327 100644 --- a/api/interfaces/SecretStorageChangeEvent.html +++ b/api/interfaces/SecretStorageChangeEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4320

\ No newline at end of file diff --git a/api/interfaces/StatusBarItem.html b/api/interfaces/StatusBarItem.html index c23fc680022..f4764acc2a1 100644 --- a/api/interfaces/StatusBarItem.html +++ b/api/interfaces/StatusBarItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: StatusBarItem

@@ -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:1319

+

packages/extension-api/src/extension-api.d.ts:1319

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:1347

+

packages/extension-api/src/extension-api.d.ts:1347

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:1352

+

packages/extension-api/src/extension-api.d.ts:1352

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:1343

+

packages/extension-api/src/extension-api.d.ts:1343

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:1338

+

packages/extension-api/src/extension-api.d.ts:1338

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:1324

+

packages/extension-api/src/extension-api.d.ts:1324

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:1328

+

packages/extension-api/src/extension-api.d.ts:1328

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:1332

+

packages/extension-api/src/extension-api.d.ts:1332

Methods​

dispose()​

@@ -98,7 +98,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1366

+

packages/extension-api/src/extension-api.d.ts:1366

hide()​

@@ -108,7 +108,7 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1360

+

packages/extension-api/src/extension-api.d.ts:1360

show()​

@@ -118,6 +118,6 @@ or more to the right.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1356

+

packages/extension-api/src/extension-api.d.ts:1356

\ No newline at end of file diff --git a/api/interfaces/StorageStats.html b/api/interfaces/StorageStats.html index 76e3ee13f47..55283a1c31d 100644 --- a/api/interfaces/StorageStats.html +++ b/api/interfaces/StorageStats.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: StorageStats

@@ -24,27 +24,27 @@

optional read_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2901

+

packages/extension-api/src/extension-api.d.ts:2901

read_size_bytes?​

optional read_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2902

+

packages/extension-api/src/extension-api.d.ts:2902

write_count_normalized?​

optional write_count_normalized: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2903

+

packages/extension-api/src/extension-api.d.ts:2903

write_size_bytes?​

optional write_size_bytes: number

Source​

-

packages/extension-api/src/extension-api.d.ts:2904

+

packages/extension-api/src/extension-api.d.ts:2904

\ No newline at end of file diff --git a/api/interfaces/TelemetryLogger.html b/api/interfaces/TelemetryLogger.html index 89f47bc256e..4e8dd2de30f 100644 --- a/api/interfaces/TelemetryLogger.html +++ b/api/interfaces/TelemetryLogger.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: TelemetryLogger

@@ -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:3989

+

packages/extension-api/src/extension-api.d.ts:3989

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:3984

+

packages/extension-api/src/extension-api.d.ts:3984

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:3979

+

packages/extension-api/src/extension-api.d.ts:3979

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:4024

+

packages/extension-api/src/extension-api.d.ts:4024

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:4011

+

packages/extension-api/src/extension-api.d.ts:4011

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:4019

+

packages/extension-api/src/extension-api.d.ts:4019

logUsage()​

@@ -110,6 +110,6 @@ Automatically supports echoing to extension telemetry output channel.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:4000

+

packages/extension-api/src/extension-api.d.ts:4000

\ No newline at end of file diff --git a/api/interfaces/TelemetryLoggerOptions.html b/api/interfaces/TelemetryLoggerOptions.html index 0d58267ade2..bbad0bce1c7 100644 --- a/api/interfaces/TelemetryLoggerOptions.html +++ b/api/interfaces/TelemetryLoggerOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: TelemetryLoggerOptions

@@ -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:4077

+

packages/extension-api/src/extension-api.d.ts:4077

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:4065

+

packages/extension-api/src/extension-api.d.ts:4065

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:4071

+

packages/extension-api/src/extension-api.d.ts:4071

\ No newline at end of file diff --git a/api/interfaces/TelemetrySender.html b/api/interfaces/TelemetrySender.html index 8de9bee6a0d..bdba41a3477 100644 --- a/api/interfaces/TelemetrySender.html +++ b/api/interfaces/TelemetrySender.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: TelemetrySender

@@ -30,7 +30,7 @@ as its TelemetryLogger is being di

Returns​

void | Promise<void>

Source​

-

packages/extension-api/src/extension-api.d.ts:4054

+

packages/extension-api/src/extension-api.d.ts:4054

sendErrorData()​

@@ -45,7 +45,7 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:4048

+

packages/extension-api/src/extension-api.d.ts:4048

sendEventData()​

@@ -60,6 +60,6 @@ as its TelemetryLogger is being di

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:4039

+

packages/extension-api/src/extension-api.d.ts:4039

\ No newline at end of file diff --git a/api/interfaces/ThrottlingData.html b/api/interfaces/ThrottlingData.html index 4dc0c7c4b7a..78b332883a8 100644 --- a/api/interfaces/ThrottlingData.html +++ b/api/interfaces/ThrottlingData.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2976

\ No newline at end of file diff --git a/api/interfaces/UnregisterContainerConnectionEvent.html b/api/interfaces/UnregisterContainerConnectionEvent.html index 70cdd9b59ed..d529b3171e1 100644 --- a/api/interfaces/UnregisterContainerConnectionEvent.html +++ b/api/interfaces/UnregisterContainerConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:640

\ No newline at end of file diff --git a/api/interfaces/UnregisterKubernetesConnectionEvent.html b/api/interfaces/UnregisterKubernetesConnectionEvent.html index cff4436853b..7441e7d28f4 100644 --- a/api/interfaces/UnregisterKubernetesConnectionEvent.html +++ b/api/interfaces/UnregisterKubernetesConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:643

\ No newline at end of file diff --git a/api/interfaces/UpdateContainerConnectionEvent.html b/api/interfaces/UpdateContainerConnectionEvent.html index d537718dcf9..d47d1226939 100644 --- a/api/interfaces/UpdateContainerConnectionEvent.html +++ b/api/interfaces/UpdateContainerConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: UpdateContainerConnectionEvent

@@ -24,20 +24,20 @@

connection: ContainerProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:629

+

packages/extension-api/src/extension-api.d.ts:629

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:628

+

packages/extension-api/src/extension-api.d.ts:628

status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:630

+

packages/extension-api/src/extension-api.d.ts:630

\ No newline at end of file diff --git a/api/interfaces/UpdateKubernetesConnectionEvent.html b/api/interfaces/UpdateKubernetesConnectionEvent.html index 8a85ae18e81..1c4ee960e61 100644 --- a/api/interfaces/UpdateKubernetesConnectionEvent.html +++ b/api/interfaces/UpdateKubernetesConnectionEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: UpdateKubernetesConnectionEvent

@@ -24,20 +24,20 @@

connection: KubernetesProviderConnection

Source​

-

packages/extension-api/src/extension-api.d.ts:635

+

packages/extension-api/src/extension-api.d.ts:635

providerId​

providerId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:634

+

packages/extension-api/src/extension-api.d.ts:634

status​

status: ProviderConnectionStatus

Source​

-

packages/extension-api/src/extension-api.d.ts:636

+

packages/extension-api/src/extension-api.d.ts:636

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateOptions.html b/api/interfaces/VolumeCreateOptions.html index 7ec102597aa..be8f706041a 100644 --- a/api/interfaces/VolumeCreateOptions.html +++ b/api/interfaces/VolumeCreateOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3241

\ No newline at end of file diff --git a/api/interfaces/VolumeCreateResponseInfo.html b/api/interfaces/VolumeCreateResponseInfo.html index 88283c97e10..49826337203 100644 --- a/api/interfaces/VolumeCreateResponseInfo.html +++ b/api/interfaces/VolumeCreateResponseInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: VolumeCreateResponseInfo

@@ -24,14 +24,14 @@

optional CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3253

+

packages/extension-api/src/extension-api.d.ts:3253

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3251

+

packages/extension-api/src/extension-api.d.ts:3251

Labels​

@@ -40,28 +40,28 @@

Index signature​

[label: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3255

+

packages/extension-api/src/extension-api.d.ts:3255

Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3252

+

packages/extension-api/src/extension-api.d.ts:3252

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3250

+

packages/extension-api/src/extension-api.d.ts:3250

Scope​

Scope: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3256

+

packages/extension-api/src/extension-api.d.ts:3256

Status?​

@@ -70,6 +70,6 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3254

+

packages/extension-api/src/extension-api.d.ts:3254

\ No newline at end of file diff --git a/api/interfaces/VolumeDeleteOptions.html b/api/interfaces/VolumeDeleteOptions.html index ab3b4810827..da6ef4e9950 100644 --- a/api/interfaces/VolumeDeleteOptions.html +++ b/api/interfaces/VolumeDeleteOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3246

\ No newline at end of file diff --git a/api/interfaces/VolumeInfo.html b/api/interfaces/VolumeInfo.html index 90133ca95e9..c6987f24c8c 100644 --- a/api/interfaces/VolumeInfo.html +++ b/api/interfaces/VolumeInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: VolumeInfo

@@ -24,14 +24,14 @@

CreatedAt: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3217

+

packages/extension-api/src/extension-api.d.ts:3217

Driver​

Driver: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3220

+

packages/extension-api/src/extension-api.d.ts:3220

Labels​

@@ -40,35 +40,35 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3223

+

packages/extension-api/src/extension-api.d.ts:3223

Mountpoint​

Mountpoint: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3221

+

packages/extension-api/src/extension-api.d.ts:3221

Name​

Name: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3219

+

packages/extension-api/src/extension-api.d.ts:3219

Options?​

optional Options: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3225

+

packages/extension-api/src/extension-api.d.ts:3225

Scope​

Scope: "global" | "local"

Source​

-

packages/extension-api/src/extension-api.d.ts:3224

+

packages/extension-api/src/extension-api.d.ts:3224

Status?​

@@ -77,34 +77,34 @@

Index signature​

[key: string]: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3222

+

packages/extension-api/src/extension-api.d.ts:3222

UsageData?​

optional UsageData: null | object

Source​

-

packages/extension-api/src/extension-api.d.ts:3226

+

packages/extension-api/src/extension-api.d.ts:3226

containersUsage​

containersUsage: object[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3218

+

packages/extension-api/src/extension-api.d.ts:3218

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3215

+

packages/extension-api/src/extension-api.d.ts:3215

engineName​

engineName: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3216

+

packages/extension-api/src/extension-api.d.ts:3216

\ No newline at end of file diff --git a/api/interfaces/VolumeListInfo.html b/api/interfaces/VolumeListInfo.html index 4af7499fc31..5433b20cdab 100644 --- a/api/interfaces/VolumeListInfo.html +++ b/api/interfaces/VolumeListInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: VolumeListInfo

@@ -24,27 +24,27 @@

Volumes: VolumeInfo[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3232

+

packages/extension-api/src/extension-api.d.ts:3232

Warnings​

Warnings: string[]

Source​

-

packages/extension-api/src/extension-api.d.ts:3233

+

packages/extension-api/src/extension-api.d.ts:3233

engineId​

engineId: string

Source​

-

packages/extension-api/src/extension-api.d.ts:3234

+

packages/extension-api/src/extension-api.d.ts:3234

engineName​

engineName: string

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/interfaces/Webview.html b/api/interfaces/Webview.html index 7df681284b4..373c1e83a88 100644 --- a/api/interfaces/Webview.html +++ b/api/interfaces/Webview.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: Webview

@@ -26,7 +26,7 @@

Content security policy source for webview resources.

Source​

-

packages/extension-api/src/extension-api.d.ts:1546

+

packages/extension-api/src/extension-api.d.ts:1546

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:1523

+

packages/extension-api/src/extension-api.d.ts:1523

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:1530

+

packages/extension-api/src/extension-api.d.ts:1530

options​

@@ -52,7 +52,7 @@

Content settings for the webview.

Source​

-

packages/extension-api/src/extension-api.d.ts:1515

+

packages/extension-api/src/extension-api.d.ts:1515

Methods​

asWebviewUri()​

@@ -64,7 +64,7 @@

Returns​

Uri

Source​

-

packages/extension-api/src/extension-api.d.ts:1540

+

packages/extension-api/src/extension-api.d.ts:1540

postMessage()​

@@ -76,6 +76,6 @@

Returns​

Promise<boolean>

Source​

-

packages/extension-api/src/extension-api.d.ts:1535

+

packages/extension-api/src/extension-api.d.ts:1535

\ No newline at end of file diff --git a/api/interfaces/WebviewInfo.html b/api/interfaces/WebviewInfo.html index 414ff327709..02b68b17152 100644 --- a/api/interfaces/WebviewInfo.html +++ b/api/interfaces/WebviewInfo.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2873

\ No newline at end of file diff --git a/api/interfaces/WebviewOptions.html b/api/interfaces/WebviewOptions.html index 26076b689eb..03a83c2bb49 100644 --- a/api/interfaces/WebviewOptions.html +++ b/api/interfaces/WebviewOptions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1505

\ No newline at end of file diff --git a/api/interfaces/WebviewPanel.html b/api/interfaces/WebviewPanel.html index 6f0904d8c95..e2c712ef9d7 100644 --- a/api/interfaces/WebviewPanel.html +++ b/api/interfaces/WebviewPanel.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Interface: WebviewPanel

@@ -26,7 +26,7 @@

Whether the panel is active (focused by the user).

Source​

-

packages/extension-api/src/extension-api.d.ts:1587

+

packages/extension-api/src/extension-api.d.ts:1587

iconPath?​

@@ -34,7 +34,7 @@

Icon for the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1566

+

packages/extension-api/src/extension-api.d.ts:1566

onDidChangeViewState​

@@ -42,7 +42,7 @@

Fired when the panel's view state changes.

Source​

-

packages/extension-api/src/extension-api.d.ts:1597

+

packages/extension-api/src/extension-api.d.ts:1597

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:1607

+

packages/extension-api/src/extension-api.d.ts:1607

title​

@@ -61,7 +61,7 @@ called on it.

Title of the panel shown in UI.

Source​

-

packages/extension-api/src/extension-api.d.ts:1561

+

packages/extension-api/src/extension-api.d.ts:1561

viewType​

@@ -69,7 +69,7 @@ called on it.

Identifies the type of the webview panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1556

+

packages/extension-api/src/extension-api.d.ts:1556

visible​

@@ -77,7 +77,7 @@ called on it.

Whether the panel is visible.

Source​

-

packages/extension-api/src/extension-api.d.ts:1592

+

packages/extension-api/src/extension-api.d.ts:1592

webview​

@@ -85,7 +85,7 @@ called on it.

Webview belonging to the panel.

Source​

-

packages/extension-api/src/extension-api.d.ts:1582

+

packages/extension-api/src/extension-api.d.ts:1582

Methods​

dispose()​

@@ -98,7 +98,7 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1622

+

packages/extension-api/src/extension-api.d.ts:1622

reveal()​

@@ -111,6 +111,6 @@ fire the onDispose event.

Returns​

void

Source​

-

packages/extension-api/src/extension-api.d.ts:1613

+

packages/extension-api/src/extension-api.d.ts:1613

\ No newline at end of file diff --git a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html index ea8be008120..ec38ceacb01 100644 --- a/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html +++ b/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1694

\ No newline at end of file diff --git a/api/namespaces/authentication.html b/api/namespaces/authentication.html index fee0f4727d4..513c2ef25b8 100644 --- a/api/namespaces/authentication.html +++ b/api/namespaces/authentication.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: authentication

diff --git a/api/namespaces/authentication/functions/getSession.html b/api/namespaces/authentication/functions/getSession.html index 870b9514700..7cce05d5fdd 100644 --- a/api/namespaces/authentication/functions/getSession.html +++ b/api/namespaces/authentication/functions/getSession.html @@ -13,8 +13,8 @@ - - + +

Function: getSession()

@@ -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:3726

+

packages/extension-api/src/extension-api.d.ts:3726

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:3745

+

packages/extension-api/src/extension-api.d.ts:3745

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/onDidChangeSessions.html b/api/namespaces/authentication/functions/onDidChangeSessions.html index f7935c94dad..350db5925d7 100644 --- a/api/namespaces/authentication/functions/onDidChangeSessions.html +++ b/api/namespaces/authentication/functions/onDidChangeSessions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3755

\ No newline at end of file diff --git a/api/namespaces/authentication/functions/registerAuthenticationProvider.html b/api/namespaces/authentication/functions/registerAuthenticationProvider.html index 9eb58d49270..ef938ebe51e 100644 --- a/api/namespaces/authentication/functions/registerAuthenticationProvider.html +++ b/api/namespaces/authentication/functions/registerAuthenticationProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3769

\ No newline at end of file diff --git a/api/namespaces/cli.html b/api/namespaces/cli.html index 4fce748ef9d..6858d134f4f 100644 --- a/api/namespaces/cli.html +++ b/api/namespaces/cli.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: cli

diff --git a/api/namespaces/cli/functions/createCliTool.html b/api/namespaces/cli/functions/createCliTool.html index d3a98dcf785..9e8ce20bf43 100644 --- a/api/namespaces/cli/functions/createCliTool.html +++ b/api/namespaces/cli/functions/createCliTool.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:4184

\ No newline at end of file diff --git a/api/namespaces/commands.html b/api/namespaces/commands.html index 0953382819b..571cc640b35 100644 --- a/api/namespaces/commands.html +++ b/api/namespaces/commands.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: commands

diff --git a/api/namespaces/commands/functions/executeCommand.html b/api/namespaces/commands/functions/executeCommand.html index 7ee77d0e676..24062bc243c 100644 --- a/api/namespaces/commands/functions/executeCommand.html +++ b/api/namespaces/commands/functions/executeCommand.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:618

\ No newline at end of file diff --git a/api/namespaces/commands/functions/registerCommand.html b/api/namespaces/commands/functions/registerCommand.html index d22e8e02cc6..2ef22368614 100644 --- a/api/namespaces/commands/functions/registerCommand.html +++ b/api/namespaces/commands/functions/registerCommand.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:606

\ No newline at end of file diff --git a/api/namespaces/configuration.html b/api/namespaces/configuration.html index e969ed1fee4..ca11c84a2a8 100644 --- a/api/namespaces/configuration.html +++ b/api/namespaces/configuration.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: configuration

diff --git a/api/namespaces/configuration/functions/getConfiguration.html b/api/namespaces/configuration/functions/getConfiguration.html index cda31c82b50..3d772470a37 100644 --- a/api/namespaces/configuration/functions/getConfiguration.html +++ b/api/namespaces/configuration/functions/getConfiguration.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:765

\ No newline at end of file diff --git a/api/namespaces/configuration/functions/onDidChangeConfiguration.html b/api/namespaces/configuration/functions/onDidChangeConfiguration.html index a2d71869524..0deee123e50 100644 --- a/api/namespaces/configuration/functions/onDidChangeConfiguration.html +++ b/api/namespaces/configuration/functions/onDidChangeConfiguration.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:770

\ No newline at end of file diff --git a/api/namespaces/containerEngine.html b/api/namespaces/containerEngine.html index 9385d4751c0..6417379aaf1 100644 --- a/api/namespaces/containerEngine.html +++ b/api/namespaces/containerEngine.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: containerEngine

diff --git a/api/namespaces/containerEngine/functions/buildImage.html b/api/namespaces/containerEngine/functions/buildImage.html index c7981ad9710..ddbc7069d1b 100644 --- a/api/namespaces/containerEngine/functions/buildImage.html +++ b/api/namespaces/containerEngine/functions/buildImage.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:3370

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createContainer.html b/api/namespaces/containerEngine/functions/createContainer.html index 6a131da4822..a18e7f54777 100644 --- a/api/namespaces/containerEngine/functions/createContainer.html +++ b/api/namespaces/containerEngine/functions/createContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3295

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createManifest.html b/api/namespaces/containerEngine/functions/createManifest.html index e39797de2dc..8a35a52fc1a 100644 --- a/api/namespaces/containerEngine/functions/createManifest.html +++ b/api/namespaces/containerEngine/functions/createManifest.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3505

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createNetwork.html b/api/namespaces/containerEngine/functions/createNetwork.html index 5ccfed76e0f..e702bd98f31 100644 --- a/api/namespaces/containerEngine/functions/createNetwork.html +++ b/api/namespaces/containerEngine/functions/createNetwork.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3484

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createPod.html b/api/namespaces/containerEngine/functions/createPod.html index 3d707f1cb24..f09a9ff5b0d 100644 --- a/api/namespaces/containerEngine/functions/createPod.html +++ b/api/namespaces/containerEngine/functions/createPod.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3493

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/createVolume.html b/api/namespaces/containerEngine/functions/createVolume.html index b817f4a89f6..2018a6fc8ea 100644 --- a/api/namespaces/containerEngine/functions/createVolume.html +++ b/api/namespaces/containerEngine/functions/createVolume.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3490

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteContainer.html b/api/namespaces/containerEngine/functions/deleteContainer.html index 7eff77e0570..7543ba205b1 100644 --- a/api/namespaces/containerEngine/functions/deleteContainer.html +++ b/api/namespaces/containerEngine/functions/deleteContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3362

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteImage.html b/api/namespaces/containerEngine/functions/deleteImage.html index 613430a4c72..b862b8a7b49 100644 --- a/api/namespaces/containerEngine/functions/deleteImage.html +++ b/api/namespaces/containerEngine/functions/deleteImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3450

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/deleteVolume.html b/api/namespaces/containerEngine/functions/deleteVolume.html index e8e4d3dae3a..b49609b1f14 100644 --- a/api/namespaces/containerEngine/functions/deleteVolume.html +++ b/api/namespaces/containerEngine/functions/deleteVolume.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3491

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/getImageInspect.html b/api/namespaces/containerEngine/functions/getImageInspect.html index 5834b1042ae..af22861bf14 100644 --- a/api/namespaces/containerEngine/functions/getImageInspect.html +++ b/api/namespaces/containerEngine/functions/getImageInspect.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3459

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/info.html b/api/namespaces/containerEngine/functions/info.html index 2605f6c6f0b..08e7fd1c441 100644 --- a/api/namespaces/containerEngine/functions/info.html +++ b/api/namespaces/containerEngine/functions/info.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3461

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectContainer.html b/api/namespaces/containerEngine/functions/inspectContainer.html index 7918b0a01b8..dc071e2cdbe 100644 --- a/api/namespaces/containerEngine/functions/inspectContainer.html +++ b/api/namespaces/containerEngine/functions/inspectContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3286

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/inspectManifest.html b/api/namespaces/containerEngine/functions/inspectManifest.html index 4cde83660ff..e8c076b6a76 100644 --- a/api/namespaces/containerEngine/functions/inspectManifest.html +++ b/api/namespaces/containerEngine/functions/inspectManifest.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3506

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listContainers.html b/api/namespaces/containerEngine/functions/listContainers.html index 56984ecc6bd..bd8fe824c24 100644 --- a/api/namespaces/containerEngine/functions/listContainers.html +++ b/api/namespaces/containerEngine/functions/listContainers.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3277

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listImages.html b/api/namespaces/containerEngine/functions/listImages.html index e3e9415e553..dc784a64edb 100644 --- a/api/namespaces/containerEngine/functions/listImages.html +++ b/api/namespaces/containerEngine/functions/listImages.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Function: listImages()

@@ -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:3402

+

packages/extension-api/src/extension-api.d.ts:3402

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listInfos.html b/api/namespaces/containerEngine/functions/listInfos.html index 35884c83c9a..21674fbbe84 100644 --- a/api/namespaces/containerEngine/functions/listInfos.html +++ b/api/namespaces/containerEngine/functions/listInfos.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Function: listInfos()

@@ -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:3480

+

packages/extension-api/src/extension-api.d.ts:3480

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listNetworks.html b/api/namespaces/containerEngine/functions/listNetworks.html index ad288a03e80..bbf08762261 100644 --- a/api/namespaces/containerEngine/functions/listNetworks.html +++ b/api/namespaces/containerEngine/functions/listNetworks.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3483

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listPods.html b/api/namespaces/containerEngine/functions/listPods.html index 175b2ddf54b..e1aacd9a90f 100644 --- a/api/namespaces/containerEngine/functions/listPods.html +++ b/api/namespaces/containerEngine/functions/listPods.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3500

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/listVolumes.html b/api/namespaces/containerEngine/functions/listVolumes.html index f9f32f50ef3..b6f212d794e 100644 --- a/api/namespaces/containerEngine/functions/listVolumes.html +++ b/api/namespaces/containerEngine/functions/listVolumes.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3489

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/logsContainer.html b/api/namespaces/containerEngine/functions/logsContainer.html index 18e49a03a30..2c92f63bc4a 100644 --- a/api/namespaces/containerEngine/functions/logsContainer.html +++ b/api/namespaces/containerEngine/functions/logsContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3315

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/onEvent.html b/api/namespaces/containerEngine/functions/onEvent.html index 3172393aa85..d6649872a75 100644 --- a/api/namespaces/containerEngine/functions/onEvent.html +++ b/api/namespaces/containerEngine/functions/onEvent.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3481

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pullImage.html b/api/namespaces/containerEngine/functions/pullImage.html index 4255a6b1c27..53370380a5a 100644 --- a/api/namespaces/containerEngine/functions/pullImage.html +++ b/api/namespaces/containerEngine/functions/pullImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3438

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/pushImage.html b/api/namespaces/containerEngine/functions/pushImage.html index ac4eb5ab230..bc25f88edc3 100644 --- a/api/namespaces/containerEngine/functions/pushImage.html +++ b/api/namespaces/containerEngine/functions/pushImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3424

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/removePod.html b/api/namespaces/containerEngine/functions/removePod.html index 048d74fefe3..8e0108f6f10 100644 --- a/api/namespaces/containerEngine/functions/removePod.html +++ b/api/namespaces/containerEngine/functions/removePod.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3502

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html index 794e304ef8b..ef4c4b743d0 100644 --- a/api/namespaces/containerEngine/functions/replicatePodmanContainer.html +++ b/api/namespaces/containerEngine/functions/replicatePodmanContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3494

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/saveImage.html b/api/namespaces/containerEngine/functions/saveImage.html index 01eec4be88b..8ca04d2ce42 100644 --- a/api/namespaces/containerEngine/functions/saveImage.html +++ b/api/namespaces/containerEngine/functions/saveImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3383

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startContainer.html b/api/namespaces/containerEngine/functions/startContainer.html index d40af0074e4..a97f5023b48 100644 --- a/api/namespaces/containerEngine/functions/startContainer.html +++ b/api/namespaces/containerEngine/functions/startContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3306

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/startPod.html b/api/namespaces/containerEngine/functions/startPod.html index b16ec41befb..6594dc9b45f 100644 --- a/api/namespaces/containerEngine/functions/startPod.html +++ b/api/namespaces/containerEngine/functions/startPod.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3499

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/statsContainer.html b/api/namespaces/containerEngine/functions/statsContainer.html index f3ebbf047d2..121b1b7d343 100644 --- a/api/namespaces/containerEngine/functions/statsContainer.html +++ b/api/namespaces/containerEngine/functions/statsContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3341

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopContainer.html b/api/namespaces/containerEngine/functions/stopContainer.html index 1f39912c513..20fea8e6c9f 100644 --- a/api/namespaces/containerEngine/functions/stopContainer.html +++ b/api/namespaces/containerEngine/functions/stopContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3353

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/stopPod.html b/api/namespaces/containerEngine/functions/stopPod.html index c58a860ff04..69e5766e6a2 100644 --- a/api/namespaces/containerEngine/functions/stopPod.html +++ b/api/namespaces/containerEngine/functions/stopPod.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3501

\ No newline at end of file diff --git a/api/namespaces/containerEngine/functions/tagImage.html b/api/namespaces/containerEngine/functions/tagImage.html index 734d6fe7f01..16ff8bb3786 100644 --- a/api/namespaces/containerEngine/functions/tagImage.html +++ b/api/namespaces/containerEngine/functions/tagImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3412

\ No newline at end of file diff --git a/api/namespaces/context.html b/api/namespaces/context.html index c942425c22c..ce91f30be72 100644 --- a/api/namespaces/context.html +++ b/api/namespaces/context.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: context

diff --git a/api/namespaces/context/functions/setValue.html b/api/namespaces/context/functions/setValue.html index 9dd652a767c..dfa348735dd 100644 --- a/api/namespaces/context/functions/setValue.html +++ b/api/namespaces/context/functions/setValue.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:4111

\ No newline at end of file diff --git a/api/namespaces/env.html b/api/namespaces/env.html index 82bb2d31fc6..558dbb8b69c 100644 --- a/api/namespaces/env.html +++ b/api/namespaces/env.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: env

diff --git a/api/namespaces/env/functions/createTelemetryLogger.html b/api/namespaces/env/functions/createTelemetryLogger.html index 6ac15283ebb..3abec8b4879 100644 --- a/api/namespaces/env/functions/createTelemetryLogger.html +++ b/api/namespaces/env/functions/createTelemetryLogger.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:3832

\ No newline at end of file diff --git a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html index e6b49211137..6ad87508562 100644 --- a/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html +++ b/api/namespaces/env/functions/onDidChangeTelemetryEnabled.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3815

\ No newline at end of file diff --git a/api/namespaces/env/functions/openExternal.html b/api/namespaces/env/functions/openExternal.html index d3d077f72c8..cd018c1f8a3 100644 --- a/api/namespaces/env/functions/openExternal.html +++ b/api/namespaces/env/functions/openExternal.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3823

\ No newline at end of file diff --git a/api/namespaces/env/variables/clipboard.html b/api/namespaces/env/variables/clipboard.html index 9ce9655d8c7..26f36a4e575 100644 --- a/api/namespaces/env/variables/clipboard.html +++ b/api/namespaces/env/variables/clipboard.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3837

\ No newline at end of file diff --git a/api/namespaces/env/variables/isLinux.html b/api/namespaces/env/variables/isLinux.html index a4d963b85ec..b14309ef456 100644 --- a/api/namespaces/env/variables/isLinux.html +++ b/api/namespaces/env/variables/isLinux.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3803

\ No newline at end of file diff --git a/api/namespaces/env/variables/isMac.html b/api/namespaces/env/variables/isMac.html index 105a12b2d48..d3565c6af68 100644 --- a/api/namespaces/env/variables/isMac.html +++ b/api/namespaces/env/variables/isMac.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3787

\ No newline at end of file diff --git a/api/namespaces/env/variables/isTelemetryEnabled.html b/api/namespaces/env/variables/isTelemetryEnabled.html index 82af4f1aac3..82f584faeca 100644 --- a/api/namespaces/env/variables/isTelemetryEnabled.html +++ b/api/namespaces/env/variables/isTelemetryEnabled.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3809

\ No newline at end of file diff --git a/api/namespaces/env/variables/isWindows.html b/api/namespaces/env/variables/isWindows.html index f8445989b54..adb4b1a3d05 100644 --- a/api/namespaces/env/variables/isWindows.html +++ b/api/namespaces/env/variables/isWindows.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:3795

\ No newline at end of file diff --git a/api/namespaces/extensions.html b/api/namespaces/extensions.html index b81f1ae624d..454e1e0a7ad 100644 --- a/api/namespaces/extensions.html +++ b/api/namespaces/extensions.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: extensions

diff --git a/api/namespaces/extensions/functions/getExtension.html b/api/namespaces/extensions/functions/getExtension.html index bbd123287a3..aaae30f7a3d 100644 --- a/api/namespaces/extensions/functions/getExtension.html +++ b/api/namespaces/extensions/functions/getExtension.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:234

\ No newline at end of file diff --git a/api/namespaces/extensions/functions/onDidChange.html b/api/namespaces/extensions/functions/onDidChange.html index fcdea048e84..42a6b16c8f9 100644 --- a/api/namespaces/extensions/functions/onDidChange.html +++ b/api/namespaces/extensions/functions/onDidChange.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:246

\ No newline at end of file diff --git a/api/namespaces/extensions/variables/all.html b/api/namespaces/extensions/variables/all.html index fc40569c4a7..48720d426bd 100644 --- a/api/namespaces/extensions/variables/all.html +++ b/api/namespaces/extensions/variables/all.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:240

\ No newline at end of file diff --git a/api/namespaces/fs.html b/api/namespaces/fs.html index 8e7c972dfed..fa223923072 100644 --- a/api/namespaces/fs.html +++ b/api/namespaces/fs.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: fs

diff --git a/api/namespaces/fs/functions/createFileSystemWatcher.html b/api/namespaces/fs/functions/createFileSystemWatcher.html index 9ab46738bf3..68a85a9801d 100644 --- a/api/namespaces/fs/functions/createFileSystemWatcher.html +++ b/api/namespaces/fs/functions/createFileSystemWatcher.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:1491

\ No newline at end of file diff --git a/api/namespaces/imageChecker.html b/api/namespaces/imageChecker.html index 7464f595d9b..c35a9f089dc 100644 --- a/api/namespaces/imageChecker.html +++ b/api/namespaces/imageChecker.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: imageChecker

diff --git a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html index fb01f252522..e3b22c3405b 100644 --- a/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html +++ b/api/namespaces/imageChecker/functions/registerImageCheckerProvider.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:4254

\ No newline at end of file diff --git a/api/namespaces/kubernetes.html b/api/namespaces/kubernetes.html index 5c61e8bb5d0..4da007c6f5d 100644 --- a/api/namespaces/kubernetes.html +++ b/api/namespaces/kubernetes.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: kubernetes

diff --git a/api/namespaces/kubernetes/functions/createResources.html b/api/namespaces/kubernetes/functions/createResources.html index 5973c28e2d7..f17954ed575 100644 --- a/api/namespaces/kubernetes/functions/createResources.html +++ b/api/namespaces/kubernetes/functions/createResources.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:1926

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/getKubeconfig.html b/api/namespaces/kubernetes/functions/getKubeconfig.html index 5ee6fdc3b13..d875301d708 100644 --- a/api/namespaces/kubernetes/functions/getKubeconfig.html +++ b/api/namespaces/kubernetes/functions/getKubeconfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1916

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html index 2e799905abd..021b20fbc63 100644 --- a/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html +++ b/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1917

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html index 01355f6abe6..2a61bff6434 100644 --- a/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html +++ b/api/namespaces/kubernetes/functions/registerKubernetesGenerator.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1933

\ No newline at end of file diff --git a/api/namespaces/kubernetes/functions/setKubeconfig.html b/api/namespaces/kubernetes/functions/setKubeconfig.html index 7057538772a..b8a851a6323 100644 --- a/api/namespaces/kubernetes/functions/setKubeconfig.html +++ b/api/namespaces/kubernetes/functions/setKubeconfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1918

\ No newline at end of file diff --git a/api/namespaces/navigation.html b/api/namespaces/navigation.html index 1e240a8a70e..2a9f7089ad6 100644 --- a/api/namespaces/navigation.html +++ b/api/namespaces/navigation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: navigation

diff --git a/api/namespaces/navigation/functions/navigateToAuthentication.html b/api/namespaces/navigation/functions/navigateToAuthentication.html index 134192a34e0..c27a3913d4c 100644 --- a/api/namespaces/navigation/functions/navigateToAuthentication.html +++ b/api/namespaces/navigation/functions/navigateToAuthentication.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:4301

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainer.html b/api/namespaces/navigation/functions/navigateToContainer.html index 9a44b1716b0..478f64dbc86 100644 --- a/api/namespaces/navigation/functions/navigateToContainer.html +++ b/api/namespaces/navigation/functions/navigateToContainer.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4264

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerInspect.html b/api/namespaces/navigation/functions/navigateToContainerInspect.html index 3e957b11e69..6780e0e5692 100644 --- a/api/namespaces/navigation/functions/navigateToContainerInspect.html +++ b/api/namespaces/navigation/functions/navigateToContainerInspect.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4268

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerLogs.html b/api/namespaces/navigation/functions/navigateToContainerLogs.html index 3088eeefaf0..e15826f098f 100644 --- a/api/namespaces/navigation/functions/navigateToContainerLogs.html +++ b/api/namespaces/navigation/functions/navigateToContainerLogs.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4266

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainerTerminal.html b/api/namespaces/navigation/functions/navigateToContainerTerminal.html index fb1d829caa6..280fe40f254 100644 --- a/api/namespaces/navigation/functions/navigateToContainerTerminal.html +++ b/api/namespaces/navigation/functions/navigateToContainerTerminal.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4270

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContainers.html b/api/namespaces/navigation/functions/navigateToContainers.html index d975e65b10e..badf273f1d9 100644 --- a/api/namespaces/navigation/functions/navigateToContainers.html +++ b/api/namespaces/navigation/functions/navigateToContainers.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4262

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToContribution.html b/api/namespaces/navigation/functions/navigateToContribution.html index 44976b10a4b..4e364dcc840 100644 --- a/api/namespaces/navigation/functions/navigateToContribution.html +++ b/api/namespaces/navigation/functions/navigateToContribution.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4288

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html index d4ab7826b49..dabb4c71d61 100644 --- a/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html +++ b/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4310

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImage.html b/api/namespaces/navigation/functions/navigateToImage.html index 657edc84c93..982750d8bb8 100644 --- a/api/namespaces/navigation/functions/navigateToImage.html +++ b/api/namespaces/navigation/functions/navigateToImage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4275

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToImages.html b/api/namespaces/navigation/functions/navigateToImages.html index a6fc937fad4..27f6281ac9b 100644 --- a/api/namespaces/navigation/functions/navigateToImages.html +++ b/api/namespaces/navigation/functions/navigateToImages.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4273

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPod.html b/api/namespaces/navigation/functions/navigateToPod.html index 58fcaa04867..2fcf56fae53 100644 --- a/api/namespaces/navigation/functions/navigateToPod.html +++ b/api/namespaces/navigation/functions/navigateToPod.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4285

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToPods.html b/api/namespaces/navigation/functions/navigateToPods.html index fceb536ae1e..f6a2aa03e9e 100644 --- a/api/namespaces/navigation/functions/navigateToPods.html +++ b/api/namespaces/navigation/functions/navigateToPods.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4283

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToResources.html b/api/namespaces/navigation/functions/navigateToResources.html index a2ff311f749..aaf4d898a2e 100644 --- a/api/namespaces/navigation/functions/navigateToResources.html +++ b/api/namespaces/navigation/functions/navigateToResources.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4306

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolume.html b/api/namespaces/navigation/functions/navigateToVolume.html index 5f4242b1eb8..2f1067a4262 100644 --- a/api/namespaces/navigation/functions/navigateToVolume.html +++ b/api/namespaces/navigation/functions/navigateToVolume.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4280

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToVolumes.html b/api/namespaces/navigation/functions/navigateToVolumes.html index 53694e4590b..037dbdc9915 100644 --- a/api/namespaces/navigation/functions/navigateToVolumes.html +++ b/api/namespaces/navigation/functions/navigateToVolumes.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4278

\ No newline at end of file diff --git a/api/namespaces/navigation/functions/navigateToWebview.html b/api/namespaces/navigation/functions/navigateToWebview.html index b41bcad4f1f..a0340eee61c 100644 --- a/api/namespaces/navigation/functions/navigateToWebview.html +++ b/api/namespaces/navigation/functions/navigateToWebview.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4296

\ No newline at end of file diff --git a/api/namespaces/process.html b/api/namespaces/process.html index 3bf70ea050b..c8b2777a38e 100644 --- a/api/namespaces/process.html +++ b/api/namespaces/process.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: process

diff --git a/api/namespaces/process/functions/exec.html b/api/namespaces/process/functions/exec.html index 3f34ab9d881..ad7b38a27a3 100644 --- a/api/namespaces/process/functions/exec.html +++ b/api/namespaces/process/functions/exec.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:3948

\ No newline at end of file diff --git a/api/namespaces/provider.html b/api/namespaces/provider.html index d4f2eb4911a..70019c7ad4e 100644 --- a/api/namespaces/provider.html +++ b/api/namespaces/provider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: provider

diff --git a/api/namespaces/provider/functions/createProvider.html b/api/namespaces/provider/functions/createProvider.html index 6a208b6cc5b..f9d146e230a 100644 --- a/api/namespaces/provider/functions/createProvider.html +++ b/api/namespaces/provider/functions/createProvider.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:658

\ No newline at end of file diff --git a/api/namespaces/provider/functions/getContainerConnections.html b/api/namespaces/provider/functions/getContainerConnections.html index ee25834138b..e32ebe328af 100644 --- a/api/namespaces/provider/functions/getContainerConnections.html +++ b/api/namespaces/provider/functions/getContainerConnections.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:664

\ No newline at end of file diff --git a/api/namespaces/provider/functions/getProviderLifecycleContext.html b/api/namespaces/provider/functions/getProviderLifecycleContext.html index 40ed7496934..1b4569aa5fd 100644 --- a/api/namespaces/provider/functions/getProviderLifecycleContext.html +++ b/api/namespaces/provider/functions/getProviderLifecycleContext.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:674

\ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html index ce66073f2f1..78dbca90ca3 100644 --- a/api/namespaces/provider/functions/onDidRegisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidRegisterContainerConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:663

\ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html index 921fc9aaebf..5c69254ad5e 100644 --- a/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUnregisterContainerConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:662

\ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html index 83612149d72..3f7fde0235d 100644 --- a/api/namespaces/provider/functions/onDidUpdateContainerConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateContainerConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:660

\ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html index 8cbd6f2676a..702b27274ac 100644 --- a/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html +++ b/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:661

\ No newline at end of file diff --git a/api/namespaces/provider/functions/onDidUpdateProvider.html b/api/namespaces/provider/functions/onDidUpdateProvider.html index 4498c89fec8..1cb4b389c6d 100644 --- a/api/namespaces/provider/functions/onDidUpdateProvider.html +++ b/api/namespaces/provider/functions/onDidUpdateProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:659

\ No newline at end of file diff --git a/api/namespaces/proxy.html b/api/namespaces/proxy.html index 04f8f5a99ed..9bc79e98d95 100644 --- a/api/namespaces/proxy.html +++ b/api/namespaces/proxy.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: proxy

diff --git a/api/namespaces/proxy/functions/getProxySettings.html b/api/namespaces/proxy/functions/getProxySettings.html index 173f0adc716..99b80516bf5 100644 --- a/api/namespaces/proxy/functions/getProxySettings.html +++ b/api/namespaces/proxy/functions/getProxySettings.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:687

\ No newline at end of file diff --git a/api/namespaces/proxy/functions/isEnabled.html b/api/namespaces/proxy/functions/isEnabled.html index bfa4bf48a1e..c30784f5467 100644 --- a/api/namespaces/proxy/functions/isEnabled.html +++ b/api/namespaces/proxy/functions/isEnabled.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:693

\ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidStateChange.html b/api/namespaces/proxy/functions/onDidStateChange.html index 1995018a052..5051eea9eb8 100644 --- a/api/namespaces/proxy/functions/onDidStateChange.html +++ b/api/namespaces/proxy/functions/onDidStateChange.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:694

\ No newline at end of file diff --git a/api/namespaces/proxy/functions/onDidUpdateProxy.html b/api/namespaces/proxy/functions/onDidUpdateProxy.html index 21958edfc1f..743c42615e7 100644 --- a/api/namespaces/proxy/functions/onDidUpdateProxy.html +++ b/api/namespaces/proxy/functions/onDidUpdateProxy.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:690

\ No newline at end of file diff --git a/api/namespaces/proxy/functions/setProxy.html b/api/namespaces/proxy/functions/setProxy.html index 8fa6721a783..c0b7d3fd9ab 100644 --- a/api/namespaces/proxy/functions/setProxy.html +++ b/api/namespaces/proxy/functions/setProxy.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:688

\ No newline at end of file diff --git a/api/namespaces/registry.html b/api/namespaces/registry.html index b4b8bba0cbd..c8a87bd17df 100644 --- a/api/namespaces/registry.html +++ b/api/namespaces/registry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: registry

diff --git a/api/namespaces/registry/functions/onDidRegisterRegistry.html b/api/namespaces/registry/functions/onDidRegisterRegistry.html index 2a204f4d91b..1ced724aee7 100644 --- a/api/namespaces/registry/functions/onDidRegisterRegistry.html +++ b/api/namespaces/registry/functions/onDidRegisterRegistry.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:744

\ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUnregisterRegistry.html b/api/namespaces/registry/functions/onDidUnregisterRegistry.html index 54a4eeaa94b..ef80676b33a 100644 --- a/api/namespaces/registry/functions/onDidUnregisterRegistry.html +++ b/api/namespaces/registry/functions/onDidUnregisterRegistry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:746

\ No newline at end of file diff --git a/api/namespaces/registry/functions/onDidUpdateRegistry.html b/api/namespaces/registry/functions/onDidUpdateRegistry.html index 09d987bf2d7..2e814fd3677 100644 --- a/api/namespaces/registry/functions/onDidUpdateRegistry.html +++ b/api/namespaces/registry/functions/onDidUpdateRegistry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:745

\ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistry.html b/api/namespaces/registry/functions/registerRegistry.html index b5d64599487..91f6a58419b 100644 --- a/api/namespaces/registry/functions/registerRegistry.html +++ b/api/namespaces/registry/functions/registerRegistry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:736

\ No newline at end of file diff --git a/api/namespaces/registry/functions/registerRegistryProvider.html b/api/namespaces/registry/functions/registerRegistryProvider.html index a470393654d..f05672adf56 100644 --- a/api/namespaces/registry/functions/registerRegistryProvider.html +++ b/api/namespaces/registry/functions/registerRegistryProvider.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:733

\ No newline at end of file diff --git a/api/namespaces/registry/functions/suggestRegistry.html b/api/namespaces/registry/functions/suggestRegistry.html index 12d57099654..6650d6f4b27 100644 --- a/api/namespaces/registry/functions/suggestRegistry.html +++ b/api/namespaces/registry/functions/suggestRegistry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:742

\ No newline at end of file diff --git a/api/namespaces/registry/functions/unregisterRegistry.html b/api/namespaces/registry/functions/unregisterRegistry.html index 36b5bedb997..fdbe9dcfd53 100644 --- a/api/namespaces/registry/functions/unregisterRegistry.html +++ b/api/namespaces/registry/functions/unregisterRegistry.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:739

\ No newline at end of file diff --git a/api/namespaces/tray.html b/api/namespaces/tray.html index 80e27f4e319..7ce2c1eff50 100644 --- a/api/namespaces/tray.html +++ b/api/namespaces/tray.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: tray

diff --git a/api/namespaces/tray/functions/registerMenuItem.html b/api/namespaces/tray/functions/registerMenuItem.html index e19abee73fe..543505e8999 100644 --- a/api/namespaces/tray/functions/registerMenuItem.html +++ b/api/namespaces/tray/functions/registerMenuItem.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:754

\ No newline at end of file diff --git a/api/namespaces/tray/functions/registerProviderMenuItem.html b/api/namespaces/tray/functions/registerProviderMenuItem.html index b6ed3a3873c..94098554044 100644 --- a/api/namespaces/tray/functions/registerProviderMenuItem.html +++ b/api/namespaces/tray/functions/registerProviderMenuItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:761

\ No newline at end of file diff --git a/api/namespaces/window.html b/api/namespaces/window.html index 080716535c2..f7dc83873da 100644 --- a/api/namespaces/window.html +++ b/api/namespaces/window.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Namespace: window

diff --git a/api/namespaces/window/functions/createCustomPick.html b/api/namespaces/window/functions/createCustomPick.html index 93cbe7ba53a..fa54e0ec29d 100644 --- a/api/namespaces/window/functions/createCustomPick.html +++ b/api/namespaces/window/functions/createCustomPick.html @@ -13,8 +13,8 @@ - - + +
+

packages/extension-api/src/extension-api.d.ts:1898

\ No newline at end of file diff --git a/api/namespaces/window/functions/createStatusBarItem.html b/api/namespaces/window/functions/createStatusBarItem.html index 8583ba700e5..e001374cdea 100644 --- a/api/namespaces/window/functions/createStatusBarItem.html +++ b/api/namespaces/window/functions/createStatusBarItem.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1805

\ No newline at end of file diff --git a/api/namespaces/window/functions/createWebviewPanel.html b/api/namespaces/window/functions/createWebviewPanel.html index 778f121d22d..4af665d0026 100644 --- a/api/namespaces/window/functions/createWebviewPanel.html +++ b/api/namespaces/window/functions/createWebviewPanel.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1909

\ No newline at end of file diff --git a/api/namespaces/window/functions/listWebviews.html b/api/namespaces/window/functions/listWebviews.html index 80c49c4e9fc..0dcc263f5a7 100644 --- a/api/namespaces/window/functions/listWebviews.html +++ b/api/namespaces/window/functions/listWebviews.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1911

\ No newline at end of file diff --git a/api/namespaces/window/functions/showErrorMessage.html b/api/namespaces/window/functions/showErrorMessage.html index d04ef698a20..a41f8e27ca6 100644 --- a/api/namespaces/window/functions/showErrorMessage.html +++ b/api/namespaces/window/functions/showErrorMessage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1726

\ No newline at end of file diff --git a/api/namespaces/window/functions/showInformationMessage.html b/api/namespaces/window/functions/showInformationMessage.html index 2195a295933..daddbc6ea3e 100644 --- a/api/namespaces/window/functions/showInformationMessage.html +++ b/api/namespaces/window/functions/showInformationMessage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1706

\ No newline at end of file diff --git a/api/namespaces/window/functions/showInputBox.html b/api/namespaces/window/functions/showInputBox.html index 6e0fd46e61a..7ff31b39669 100644 --- a/api/namespaces/window/functions/showInputBox.html +++ b/api/namespaces/window/functions/showInputBox.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1818

\ No newline at end of file diff --git a/api/namespaces/window/functions/showNotification.html b/api/namespaces/window/functions/showNotification.html index 3e7ae389c25..ebf19dedc13 100644 --- a/api/namespaces/window/functions/showNotification.html +++ b/api/namespaces/window/functions/showNotification.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1796

\ No newline at end of file diff --git a/api/namespaces/window/functions/showOpenDialog.html b/api/namespaces/window/functions/showOpenDialog.html index 206d96e1cc7..2aa2b5aa317 100644 --- a/api/namespaces/window/functions/showOpenDialog.html +++ b/api/namespaces/window/functions/showOpenDialog.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1827

\ No newline at end of file diff --git a/api/namespaces/window/functions/showQuickPick.html b/api/namespaces/window/functions/showQuickPick.html index b9f82a032af..68d99af8d16 100644 --- a/api/namespaces/window/functions/showQuickPick.html +++ b/api/namespaces/window/functions/showQuickPick.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Function: showQuickPick()

@@ -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:1846

+

packages/extension-api/src/extension-api.d.ts:1846

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:1860

+

packages/extension-api/src/extension-api.d.ts:1860

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:1874

+

packages/extension-api/src/extension-api.d.ts:1874

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:1888

+

packages/extension-api/src/extension-api.d.ts:1888

\ No newline at end of file diff --git a/api/namespaces/window/functions/showSaveDialog.html b/api/namespaces/window/functions/showSaveDialog.html index da9ada1ceec..eb40f3c4468 100644 --- a/api/namespaces/window/functions/showSaveDialog.html +++ b/api/namespaces/window/functions/showSaveDialog.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1836

\ No newline at end of file diff --git a/api/namespaces/window/functions/showWarningMessage.html b/api/namespaces/window/functions/showWarningMessage.html index 57c696772ba..ecf7b001b75 100644 --- a/api/namespaces/window/functions/showWarningMessage.html +++ b/api/namespaces/window/functions/showWarningMessage.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1716

\ No newline at end of file diff --git a/api/namespaces/window/functions/withProgress.html b/api/namespaces/window/functions/withProgress.html index 212292548d7..34a8721148e 100644 --- a/api/namespaces/window/functions/withProgress.html +++ b/api/namespaces/window/functions/withProgress.html @@ -13,8 +13,8 @@ - - + +
Skip to main content

Function: withProgress()

@@ -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:1787

+

packages/extension-api/src/extension-api.d.ts:1787

\ No newline at end of file diff --git a/api/type-aliases/CheckResultLink.html b/api/type-aliases/CheckResultLink.html index beef1dd2799..a25181cc8c7 100644 --- a/api/type-aliases/CheckResultLink.html +++ b/api/type-aliases/CheckResultLink.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:468

\ No newline at end of file diff --git a/api/type-aliases/CliToolState.html b/api/type-aliases/CliToolState.html index 37961e24347..1f289dac756 100644 --- a/api/type-aliases/CliToolState.html +++ b/api/type-aliases/CliToolState.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:4151

\ No newline at end of file diff --git a/api/type-aliases/ConfigurationScope.html b/api/type-aliases/ConfigurationScope.html index 9e5ea3852a2..83fd7de728f 100644 --- a/api/type-aliases/ConfigurationScope.html +++ b/api/type-aliases/ConfigurationScope.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:776

\ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorArgument.html b/api/type-aliases/KubernetesGeneratorArgument.html index 6dcd0957e89..6459d2ded1a 100644 --- a/api/type-aliases/KubernetesGeneratorArgument.html +++ b/api/type-aliases/KubernetesGeneratorArgument.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1954

\ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorSelector.html b/api/type-aliases/KubernetesGeneratorSelector.html index d6273fb4f10..18522ea3e40 100644 --- a/api/type-aliases/KubernetesGeneratorSelector.html +++ b/api/type-aliases/KubernetesGeneratorSelector.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1943

\ No newline at end of file diff --git a/api/type-aliases/KubernetesGeneratorType.html b/api/type-aliases/KubernetesGeneratorType.html index 78d4fa11f71..ce6439c8c0b 100644 --- a/api/type-aliases/KubernetesGeneratorType.html +++ b/api/type-aliases/KubernetesGeneratorType.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1945

\ No newline at end of file diff --git a/api/type-aliases/MountConfig.html b/api/type-aliases/MountConfig.html index 2eddb340429..1bfc6981cd3 100644 --- a/api/type-aliases/MountConfig.html +++ b/api/type-aliases/MountConfig.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2233

\ No newline at end of file diff --git a/api/type-aliases/MountConsistency.html b/api/type-aliases/MountConsistency.html index 022429cbcc9..30ec6e0e8a5 100644 --- a/api/type-aliases/MountConsistency.html +++ b/api/type-aliases/MountConsistency.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2205

\ No newline at end of file diff --git a/api/type-aliases/MountPropagation.html b/api/type-aliases/MountPropagation.html index 0a39fed3412..220915a41d8 100644 --- a/api/type-aliases/MountPropagation.html +++ b/api/type-aliases/MountPropagation.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2207

\ No newline at end of file diff --git a/api/type-aliases/MountType.html b/api/type-aliases/MountType.html index 7e31c3958bc..6049446c90a 100644 --- a/api/type-aliases/MountType.html +++ b/api/type-aliases/MountType.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:2203

\ No newline at end of file diff --git a/api/type-aliases/NotificationType.html b/api/type-aliases/NotificationType.html index 294090ba3d0..43a9861f6b9 100644 --- a/api/type-aliases/NotificationType.html +++ b/api/type-aliases/NotificationType.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1264

\ No newline at end of file diff --git a/api/type-aliases/ProviderConnectionStatus.html b/api/type-aliases/ProviderConnectionStatus.html index ce2db7500d3..d19223cf0c4 100644 --- a/api/type-aliases/ProviderConnectionStatus.html +++ b/api/type-aliases/ProviderConnectionStatus.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:327

\ No newline at end of file diff --git a/api/type-aliases/ProviderLinks.html b/api/type-aliases/ProviderLinks.html index 82c3b50b6e3..3f57ee1a27b 100644 --- a/api/type-aliases/ProviderLinks.html +++ b/api/type-aliases/ProviderLinks.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:532

\ No newline at end of file diff --git a/api/type-aliases/ProviderResult.html b/api/type-aliases/ProviderResult.html index 48c07d9904b..412b7691d4c 100644 --- a/api/type-aliases/ProviderResult.html +++ b/api/type-aliases/ProviderResult.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:276

\ No newline at end of file diff --git a/api/type-aliases/ProviderStatus.html b/api/type-aliases/ProviderStatus.html index a851a84e280..936b19b59d8 100644 --- a/api/type-aliases/ProviderStatus.html +++ b/api/type-aliases/ProviderStatus.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:278

\ No newline at end of file diff --git a/api/type-aliases/StatusBarAlignment.html b/api/type-aliases/StatusBarAlignment.html index 9c9988ca646..460b3ee0cb4 100644 --- a/api/type-aliases/StatusBarAlignment.html +++ b/api/type-aliases/StatusBarAlignment.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1304

\ No newline at end of file diff --git a/api/variables/StatusBarAlignLeft.html b/api/variables/StatusBarAlignLeft.html index 6d6baa4f993..f4ee7249abb 100644 --- a/api/variables/StatusBarAlignLeft.html +++ b/api/variables/StatusBarAlignLeft.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1296

\ No newline at end of file diff --git a/api/variables/StatusBarAlignRight.html b/api/variables/StatusBarAlignRight.html index 3d92ecc9963..c564b607fc0 100644 --- a/api/variables/StatusBarAlignRight.html +++ b/api/variables/StatusBarAlignRight.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1300

\ No newline at end of file diff --git a/api/variables/StatusBarItemDefaultPriority.html b/api/variables/StatusBarItemDefaultPriority.html index 805ee839e45..90eb17c2f93 100644 --- a/api/variables/StatusBarItemDefaultPriority.html +++ b/api/variables/StatusBarItemDefaultPriority.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:1309

\ No newline at end of file diff --git a/api/variables/version.html b/api/variables/version.html index cf007abfa3c..76137dea901 100644 --- a/api/variables/version.html +++ b/api/variables/version.html @@ -13,8 +13,8 @@ - - + +
Skip to main content
+

packages/extension-api/src/extension-api.d.ts:42

\ No newline at end of file diff --git a/assets/js/0029a336.254343b5.js b/assets/js/0029a336.eb7755be.js similarity index 97% rename from assets/js/0029a336.254343b5.js rename to assets/js/0029a336.eb7755be.js index 6d6fc3c3d34..43182b4e08b 100644 --- a/assets/js/0029a336.254343b5.js +++ b/assets/js/0029a336.eb7755be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19093],{14583:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1787",children:"packages/extension-api/src/extension-api.d.ts:1787"})})]})}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],{14583:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1787",children:"packages/extension-api/src/extension-api.d.ts:1787"})})]})}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.b66d45b1.js b/assets/js/0102eb3e.8a253057.js similarity index 74% rename from assets/js/0102eb3e.b66d45b1.js rename to assets/js/0102eb3e.8a253057.js index 8beeb94d355..baae4682e2c 100644 --- a/assets/js/0102eb3e.b66d45b1.js +++ b/assets/js/0102eb3e.8a253057.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{66777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const c={},r="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2872",children:"packages/extension-api/src/extension-api.d.ts:2872"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2874",children:"packages/extension-api/src/extension-api.d.ts:2874"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2873",children:"packages/extension-api/src/extension-api.d.ts:2873"})})]})}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:()=>r});var t=i(27378);const s={},c=t.createContext(s);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(s):e.components||s:r(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75542],{66777:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var t=i(24246),s=i(71670);const r={},o="Interface: WebviewInfo",c={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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2872",children:"packages/extension-api/src/extension-api.d.ts:2872"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2874",children:"packages/extension-api/src/extension-api.d.ts:2874"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2873",children:"packages/extension-api/src/extension-api.d.ts:2873"})})]})}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:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);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(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01821883.84073641.js b/assets/js/01821883.d2931721.js similarity index 81% rename from assets/js/01821883.84073641.js rename to assets/js/01821883.d2931721.js index 751c75a7ce8..493a148196b 100644 --- a/assets/js/01821883.84073641.js +++ b/assets/js/01821883.d2931721.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77683],{95061:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2239",children:"packages/extension-api/src/extension-api.d.ts:2239"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2237",children:"packages/extension-api/src/extension-api.d.ts:2237"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2238",children:"packages/extension-api/src/extension-api.d.ts:2238"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2236",children:"packages/extension-api/src/extension-api.d.ts:2236"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2240",children:"packages/extension-api/src/extension-api.d.ts:2240"})})]})}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],{95061:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var s=i(24246),t=i(71670);const c={},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,t.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2239",children:"packages/extension-api/src/extension-api.d.ts:2239"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2237",children:"packages/extension-api/src/extension-api.d.ts:2237"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2238",children:"packages/extension-api/src/extension-api.d.ts:2238"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2236",children:"packages/extension-api/src/extension-api.d.ts:2236"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2240",children:"packages/extension-api/src/extension-api.d.ts:2240"})})]})}function p(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:()=>o,a:()=>r});var s=i(27378);const t={},c=s.createContext(t);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(t):e.components||t:r(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/01a1d0f4.e6471dd1.js b/assets/js/01a1d0f4.64020423.js similarity index 96% rename from assets/js/01a1d0f4.e6471dd1.js rename to assets/js/01a1d0f4.64020423.js index 8fbd63fb753..4f1f7005a75 100644 --- a/assets/js/01a1d0f4.e6471dd1.js +++ b/assets/js/01a1d0f4.64020423.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13826],{96261:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L662",children:"packages/extension-api/src/extension-api.d.ts:662"})})]})}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],{96261:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L662",children:"packages/extension-api/src/extension-api.d.ts:662"})})]})}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.0f172b3f.js b/assets/js/030ccfd9.d039f5c8.js similarity index 97% rename from assets/js/030ccfd9.0f172b3f.js rename to assets/js/030ccfd9.d039f5c8.js index d9cad80cbab..c796d4b8518 100644 --- a/assets/js/030ccfd9.0f172b3f.js +++ b/assets/js/030ccfd9.d039f5c8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67690],{38650:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1916",children:"packages/extension-api/src/extension-api.d.ts:1916"})})]})}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],{38650:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1916",children:"packages/extension-api/src/extension-api.d.ts:1916"})})]})}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.8ea06982.js b/assets/js/04a546a4.46d587cd.js similarity index 84% rename from assets/js/04a546a4.8ea06982.js rename to assets/js/04a546a4.46d587cd.js index f4b3b22b979..ccd2534687d 100644 --- a/assets/js/04a546a4.8ea06982.js +++ b/assets/js/04a546a4.46d587cd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{44419:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4088",children:"packages/extension-api/src/extension-api.d.ts:4088"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4094",children:"packages/extension-api/src/extension-api.d.ts:4094"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17329],{44419:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const i={},d="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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4088",children:"packages/extension-api/src/extension-api.d.ts:4088"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4094",children:"packages/extension-api/src/extension-api.d.ts:4094"})})]})}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:()=>d});var t=r(27378);const s={},i=t.createContext(s);function d(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:d(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0547cb65.04ea5ab6.js b/assets/js/0547cb65.285cea4a.js similarity index 83% rename from assets/js/0547cb65.04ea5ab6.js rename to assets/js/0547cb65.285cea4a.js index 686ecbed924..fb1fbc0faac 100644 --- a/assets/js/0547cb65.04ea5ab6.js +++ b/assets/js/0547cb65.285cea4a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{6204:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=i(24246),c=i(71670);const r={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1031",children:"packages/extension-api/src/extension-api.d.ts:1031"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1027",children:"packages/extension-api/src/extension-api.d.ts:1027"})})]})}function u(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,i)=>{i.d(n,{Z:()=>a,a:()=>s});var t=i(27378);const c={},r=t.createContext(c);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(c):e.components||c:s(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30060],{6204:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1031",children:"packages/extension-api/src/extension-api.d.ts:1031"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1027",children:"packages/extension-api/src/extension-api.d.ts:1027"})})]})}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.d40b070c.js b/assets/js/065365b3.d40b070c.js new file mode 100644 index 00000000000..5f38fc0e3c1 --- /dev/null +++ b/assets/js/065365b3.d40b070c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{90952:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4216",children:"packages/extension-api/src/extension-api.d.ts:4216"})})]})}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/065365b3.e80d3fc1.js b/assets/js/065365b3.e80d3fc1.js deleted file mode 100644 index d1b751901c8..00000000000 --- a/assets/js/065365b3.e80d3fc1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43871],{90952:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>i,toc:()=>h});var t=c(24246),r=c(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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h1,{id:"interface-imagechecks",children:"Interface: ImageChecks"}),"\n",(0,t.jsx)(n.p,{children:"the complete result of an image check"}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"checks",children:"checks"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"checks"}),": ",(0,t.jsx)(n.a,{href:"/api/interfaces/ImageCheck",children:(0,t.jsx)(n.code,{children:"ImageCheck"})}),"[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"the list of errors/recommendations found during the image check"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4216",children:"packages/extension-api/src/extension-api.d.ts:4216"})})]})}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,c)=>{c.d(n,{Z:()=>i,a:()=>a});var t=c(27378);const r={},s=t.createContext(r);function a(e){const n=t.useContext(s);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:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/06a27da2.a790fabe.js b/assets/js/06a27da2.a790fabe.js deleted file mode 100644 index ef63beb6479..00000000000 --- a/assets/js/06a27da2.a790fabe.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{1590:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-podinfo",children:"Interface: PodInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"cgroup",children:"Cgroup"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Cgroup"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"containers",children:"Containers"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Containers"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/PodContainerInfo",children:(0,c.jsx)(n.code,{children:"PodContainerInfo"})}),"[]"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Created"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"infraid",children:"InfraId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"InfraId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2168",children:"packages/extension-api/src/extension-api.d.ts:2168"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Name"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2169",children:"packages/extension-api/src/extension-api.d.ts:2169"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"namespace",children:"Namespace"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Namespace"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2170",children:"packages/extension-api/src/extension-api.d.ts:2170"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"networks",children:"Networks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Networks"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2171",children:"packages/extension-api/src/extension-api.d.ts:2171"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Status"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2172",children:"packages/extension-api/src/extension-api.d.ts:2172"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineName"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"kind",children:"kind"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"kind"}),": ",(0,c.jsx)(n.code,{children:'"podman"'})," | ",(0,c.jsx)(n.code,{children:'"kubernetes"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})})]})}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:()=>d,a:()=>o});var c=s(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 d(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/06a27da2.e4657165.js b/assets/js/06a27da2.e4657165.js new file mode 100644 index 00000000000..bdbef4c9288 --- /dev/null +++ b/assets/js/06a27da2.e4657165.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14824],{1590:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2163",children:"packages/extension-api/src/extension-api.d.ts:2163"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2164",children:"packages/extension-api/src/extension-api.d.ts:2164"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2165",children:"packages/extension-api/src/extension-api.d.ts:2165"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2166",children:"packages/extension-api/src/extension-api.d.ts:2166"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2167",children:"packages/extension-api/src/extension-api.d.ts:2167"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2172",children:"packages/extension-api/src/extension-api.d.ts:2172"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2160",children:"packages/extension-api/src/extension-api.d.ts:2160"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2161",children:"packages/extension-api/src/extension-api.d.ts:2161"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2162",children:"packages/extension-api/src/extension-api.d.ts:2162"})})]})}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/0877aebd.56099ff9.js b/assets/js/0877aebd.8d542365.js similarity index 94% rename from assets/js/0877aebd.56099ff9.js rename to assets/js/0877aebd.8d542365.js index 4c5648b5c15..6ad4b7924eb 100644 --- a/assets/js/0877aebd.56099ff9.js +++ b/assets/js/0877aebd.8d542365.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[87213],{27062:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3640",children:"packages/extension-api/src/extension-api.d.ts:3640"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3638",children:"packages/extension-api/src/extension-api.d.ts:3638"})})]})}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],{27062:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3640",children:"packages/extension-api/src/extension-api.d.ts:3640"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3638",children:"packages/extension-api/src/extension-api.d.ts:3638"})})]})}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.f3f31365.js b/assets/js/0c14b239.e00c1576.js similarity index 83% rename from assets/js/0c14b239.f3f31365.js rename to assets/js/0c14b239.e00c1576.js index d8081a7df64..ba0a7f1ed6a 100644 --- a/assets/js/0c14b239.f3f31365.js +++ b/assets/js/0c14b239.e00c1576.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34479],{55264:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L770",children:"packages/extension-api/src/extension-api.d.ts:770"})})]})}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],{55264:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L770",children:"packages/extension-api/src/extension-api.d.ts:770"})})]})}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.f238a84f.js b/assets/js/0c4fad6b.0ff1a167.js similarity index 78% rename from assets/js/0c4fad6b.f238a84f.js rename to assets/js/0c4fad6b.0ff1a167.js index ad51b00afd8..483d9cdd528 100644 --- a/assets/js/0c4fad6b.f238a84f.js +++ b/assets/js/0c4fad6b.0ff1a167.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{5862:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>u});var i=t(24246),a=t(71670);const o={},c="Function: navigateToAuthentication()",s={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4301",children:"packages/extension-api/src/extension-api.d.ts:4301"})})]})}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:()=>s,a:()=>c});var i=t(27378);const a={},o=i.createContext(a);function c(n){const e=i.useContext(o);return i.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(a):n.components||a:c(n.components),i.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41976],{5862:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4301",children:"packages/extension-api/src/extension-api.d.ts:4301"})})]})}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.31ada34c.js b/assets/js/0cab2b3a.2b1fb397.js similarity index 82% rename from assets/js/0cab2b3a.31ada34c.js rename to assets/js/0cab2b3a.2b1fb397.js index db18bb15653..eeaccbca195 100644 --- a/assets/js/0cab2b3a.31ada34c.js +++ b/assets/js/0cab2b3a.2b1fb397.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{25710:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var t=s(24246),c=s(71670);const r={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})})]})}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:()=>a,a:()=>o});var t=s(27378);const c={},r=t.createContext(c);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(c):e.components||c:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85714],{25710:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L618",children:"packages/extension-api/src/extension-api.d.ts:618"})})]})}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.b635176d.js b/assets/js/0e3a398f.8109f18d.js similarity index 77% rename from assets/js/0e3a398f.b635176d.js rename to assets/js/0e3a398f.8109f18d.js index 77bcfce7369..02cb65f80b6 100644 --- a/assets/js/0e3a398f.b635176d.js +++ b/assets/js/0e3a398f.8109f18d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30466],{80171:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=t(24246),o=t(71670);const i={},c="Interface: KubernetesProviderConnectionEndpoint",s={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L412",children:"packages/extension-api/src/extension-api.d.ts:412"})})]})}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:()=>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([[30466],{80171:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L412",children:"packages/extension-api/src/extension-api.d.ts:412"})})]})}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.e95b0f8a.js b/assets/js/0e72c11a.dd39d87c.js similarity index 95% rename from assets/js/0e72c11a.e95b0f8a.js rename to assets/js/0e72c11a.dd39d87c.js index c149d18f10c..82cc5cf4e0d 100644 --- a/assets/js/0e72c11a.e95b0f8a.js +++ b/assets/js/0e72c11a.dd39d87c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19536],{85226:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4306",children:"packages/extension-api/src/extension-api.d.ts:4306"})})]})}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],{85226:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4306",children:"packages/extension-api/src/extension-api.d.ts:4306"})})]})}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 diff --git a/assets/js/0f54081d.02652115.js b/assets/js/0f54081d.ab9fe1d8.js similarity index 98% rename from assets/js/0f54081d.02652115.js rename to assets/js/0f54081d.ab9fe1d8.js index 004db43e805..d28023acb80 100644 --- a/assets/js/0f54081d.02652115.js +++ b/assets/js/0f54081d.ab9fe1d8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37073],{81497:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L674",children:"packages/extension-api/src/extension-api.d.ts:674"})})]})}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],{81497:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L674",children:"packages/extension-api/src/extension-api.d.ts:674"})})]})}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.dafcc23a.js b/assets/js/0fa6e9bf.c5c2d157.js similarity index 82% rename from assets/js/0fa6e9bf.dafcc23a.js rename to assets/js/0fa6e9bf.c5c2d157.js index 218a50943f4..5b5d372aad3 100644 --- a/assets/js/0fa6e9bf.dafcc23a.js +++ b/assets/js/0fa6e9bf.c5c2d157.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{71683:(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: extensions",permalink:"/api/namespaces/extensions/"}},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3823",children:"packages/extension-api/src/extension-api.d.ts:3823"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54063],{71683:(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: extensions",permalink:"/api/namespaces/extensions/"}},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3823",children:"packages/extension-api/src/extension-api.d.ts:3823"})})]})}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 diff --git a/assets/js/10210328.aaf0f848.js b/assets/js/10210328.2408fb08.js similarity index 96% rename from assets/js/10210328.aaf0f848.js rename to assets/js/10210328.2408fb08.js index 1d81b8767d9..1f4eaef7269 100644 --- a/assets/js/10210328.aaf0f848.js +++ b/assets/js/10210328.2408fb08.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38943],{97958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const o={},r="Function: getExtension()",c={id:"namespaces/extensions/functions/getExtension",title:"Function: getExtension()",description:"getExtension\\(extensionId): Extension\\ \\| undefined",source:"@site/api/namespaces/extensions/functions/getExtension.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/getExtension",permalink:"/api/namespaces/extensions/functions/getExtension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"all",permalink:"/api/namespaces/extensions/variables/all"},next:{title:"onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange"}},a={},d=[{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 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-getextension",children:"Function: getExtension()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getExtension"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"extensionId"}),"): ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Get an extension by its full identifier in the form of: ",(0,t.jsx)(n.code,{children:"publisher.name"}),"."]}),"\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:"any"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"extensionId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"An extension identifier."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n",(0,t.jsxs)(n.p,{children:["An extension or ",(0,t.jsx)(n.code,{children:"undefined"}),"."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L234",children:"packages/extension-api/src/extension-api.d.ts:234"})})]})}function x(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:()=>r});var t=s(27378);const i={},o=t.createContext(i);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(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38943],{97958:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const o={},r="Function: getExtension()",c={id:"namespaces/extensions/functions/getExtension",title:"Function: getExtension()",description:"getExtension\\(extensionId): Extension\\ \\| undefined",source:"@site/api/namespaces/extensions/functions/getExtension.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/getExtension",permalink:"/api/namespaces/extensions/functions/getExtension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"all",permalink:"/api/namespaces/extensions/variables/all"},next:{title:"onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange"}},a={},d=[{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 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-getextension",children:"Function: getExtension()"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"getExtension"}),"<",(0,t.jsx)(n.code,{children:"T"}),">(",(0,t.jsx)(n.code,{children:"extensionId"}),"): ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Get an extension by its full identifier in the form of: ",(0,t.jsx)(n.code,{children:"publisher.name"}),"."]}),"\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:"any"})]}),"\n",(0,t.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"extensionId"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.p,{children:"An extension identifier."}),"\n",(0,t.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"T"}),"> | ",(0,t.jsx)(n.code,{children:"undefined"})]}),"\n",(0,t.jsxs)(n.p,{children:["An extension or ",(0,t.jsx)(n.code,{children:"undefined"}),"."]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L234",children:"packages/extension-api/src/extension-api.d.ts:234"})})]})}function x(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:()=>r});var t=s(27378);const i={},o=t.createContext(i);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(i):e.components||i:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/107d77e6.72899c7d.js b/assets/js/107d77e6.e5cb1536.js similarity index 95% rename from assets/js/107d77e6.72899c7d.js rename to assets/js/107d77e6.e5cb1536.js index b5f7b050e73..711009d4f7d 100644 --- a/assets/js/107d77e6.72899c7d.js +++ b/assets/js/107d77e6.e5cb1536.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51051],{14914:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3265",children:"packages/extension-api/src/extension-api.d.ts:3265"})})]})}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],{14914:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3265",children:"packages/extension-api/src/extension-api.d.ts:3265"})})]})}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.824edf5f.js b/assets/js/123a454a.9369255d.js similarity index 80% rename from assets/js/123a454a.824edf5f.js rename to assets/js/123a454a.9369255d.js index a6ddc72b7fc..afbe3457977 100644 --- a/assets/js/123a454a.824edf5f.js +++ b/assets/js/123a454a.9369255d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{55600:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3882",children:"packages/extension-api/src/extension-api.d.ts:3882"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3892",children:"packages/extension-api/src/extension-api.d.ts:3892"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3887",children:"packages/extension-api/src/extension-api.d.ts:3887"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29693],{55600:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3882",children:"packages/extension-api/src/extension-api.d.ts:3882"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3892",children:"packages/extension-api/src/extension-api.d.ts:3892"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3887",children:"packages/extension-api/src/extension-api.d.ts:3887"})})]})}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 diff --git a/assets/js/125d93c1.9f5e63a7.js b/assets/js/125d93c1.9f5e63a7.js new file mode 100644 index 00000000000..73a3e935ef2 --- /dev/null +++ b/assets/js/125d93c1.9f5e63a7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{14566:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4283",children:"packages/extension-api/src/extension-api.d.ts:4283"})})]})}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.f9fd9f25.js b/assets/js/125d93c1.f9fd9f25.js deleted file mode 100644 index f11c28f64bf..00000000000 --- a/assets/js/125d93c1.f9fd9f25.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22228],{14566:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4283",children:"packages/extension-api/src/extension-api.d.ts:4283"})})]})}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.027b484e.js b/assets/js/12eb386e.1e8b7340.js similarity index 80% rename from assets/js/12eb386e.027b484e.js rename to assets/js/12eb386e.1e8b7340.js index 77ef2d7ad96..1e98b38dd23 100644 --- a/assets/js/12eb386e.027b484e.js +++ b/assets/js/12eb386e.1e8b7340.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{71960:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(24246),o=s(71670);const t={},c="Interface: CliToolOptions",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4120",children:"packages/extension-api/src/extension-api.d.ts:4120"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4122",children:"packages/extension-api/src/extension-api.d.ts:4122"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4121",children:"packages/extension-api/src/extension-api.d.ts:4121"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4119",children:"packages/extension-api/src/extension-api.d.ts:4119"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4132",children:"packages/extension-api/src/extension-api.d.ts:4132"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4131",children:"packages/extension-api/src/extension-api.d.ts:4131"})})]})}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:()=>r,a:()=>c});var i=s(27378);const o={},t=i.createContext(o);function c(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(o):e.components||o:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89950],{71960:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4120",children:"packages/extension-api/src/extension-api.d.ts:4120"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4122",children:"packages/extension-api/src/extension-api.d.ts:4122"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4121",children:"packages/extension-api/src/extension-api.d.ts:4121"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4119",children:"packages/extension-api/src/extension-api.d.ts:4119"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4132",children:"packages/extension-api/src/extension-api.d.ts:4132"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4131",children:"packages/extension-api/src/extension-api.d.ts:4131"})})]})}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/148448cb.0e710c08.js b/assets/js/148448cb.3d77015c.js similarity index 87% rename from assets/js/148448cb.0e710c08.js rename to assets/js/148448cb.3d77015c.js index 8d120fd2574..e20db2984f2 100644 --- a/assets/js/148448cb.0e710c08.js +++ b/assets/js/148448cb.3d77015c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{66137:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2763",children:"packages/extension-api/src/extension-api.d.ts:2763"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2768",children:"packages/extension-api/src/extension-api.d.ts:2768"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2751",children:"packages/extension-api/src/extension-api.d.ts:2751"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2788",children:"packages/extension-api/src/extension-api.d.ts:2788"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2705",children:"packages/extension-api/src/extension-api.d.ts:2705"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2758",children:"packages/extension-api/src/extension-api.d.ts:2758"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2715",children:"packages/extension-api/src/extension-api.d.ts:2715"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2720",children:"packages/extension-api/src/extension-api.d.ts:2720"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2731",children:"packages/extension-api/src/extension-api.d.ts:2731"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2798",children:"packages/extension-api/src/extension-api.d.ts:2798"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2736",children:"packages/extension-api/src/extension-api.d.ts:2736"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2700",children:"packages/extension-api/src/extension-api.d.ts:2700"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2741",children:"packages/extension-api/src/extension-api.d.ts:2741"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2725",children:"packages/extension-api/src/extension-api.d.ts:2725"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2825",children:"packages/extension-api/src/extension-api.d.ts:2825"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2849",children:"packages/extension-api/src/extension-api.d.ts:2849"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2820",children:"packages/extension-api/src/extension-api.d.ts:2820"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2830",children:"packages/extension-api/src/extension-api.d.ts:2830"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2847",children:"packages/extension-api/src/extension-api.d.ts:2847"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2783",children:"packages/extension-api/src/extension-api.d.ts:2783"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2835",children:"packages/extension-api/src/extension-api.d.ts:2835"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2746",children:"packages/extension-api/src/extension-api.d.ts:2746"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2710",children:"packages/extension-api/src/extension-api.d.ts:2710"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2810",children:"packages/extension-api/src/extension-api.d.ts:2810"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2815",children:"packages/extension-api/src/extension-api.d.ts:2815"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2695",children:"packages/extension-api/src/extension-api.d.ts:2695"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2854",children:"packages/extension-api/src/extension-api.d.ts:2854"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2793",children:"packages/extension-api/src/extension-api.d.ts:2793"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72092],{66137:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2805",children:"packages/extension-api/src/extension-api.d.ts:2805"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2763",children:"packages/extension-api/src/extension-api.d.ts:2763"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2768",children:"packages/extension-api/src/extension-api.d.ts:2768"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2751",children:"packages/extension-api/src/extension-api.d.ts:2751"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2788",children:"packages/extension-api/src/extension-api.d.ts:2788"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2705",children:"packages/extension-api/src/extension-api.d.ts:2705"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2758",children:"packages/extension-api/src/extension-api.d.ts:2758"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2715",children:"packages/extension-api/src/extension-api.d.ts:2715"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2720",children:"packages/extension-api/src/extension-api.d.ts:2720"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2731",children:"packages/extension-api/src/extension-api.d.ts:2731"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2798",children:"packages/extension-api/src/extension-api.d.ts:2798"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2736",children:"packages/extension-api/src/extension-api.d.ts:2736"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2700",children:"packages/extension-api/src/extension-api.d.ts:2700"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2741",children:"packages/extension-api/src/extension-api.d.ts:2741"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2725",children:"packages/extension-api/src/extension-api.d.ts:2725"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2825",children:"packages/extension-api/src/extension-api.d.ts:2825"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2849",children:"packages/extension-api/src/extension-api.d.ts:2849"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2820",children:"packages/extension-api/src/extension-api.d.ts:2820"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2830",children:"packages/extension-api/src/extension-api.d.ts:2830"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2847",children:"packages/extension-api/src/extension-api.d.ts:2847"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2783",children:"packages/extension-api/src/extension-api.d.ts:2783"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2835",children:"packages/extension-api/src/extension-api.d.ts:2835"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2842",children:"packages/extension-api/src/extension-api.d.ts:2842"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2746",children:"packages/extension-api/src/extension-api.d.ts:2746"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2710",children:"packages/extension-api/src/extension-api.d.ts:2710"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2810",children:"packages/extension-api/src/extension-api.d.ts:2810"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2815",children:"packages/extension-api/src/extension-api.d.ts:2815"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2678",children:"packages/extension-api/src/extension-api.d.ts:2678"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2695",children:"packages/extension-api/src/extension-api.d.ts:2695"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2854",children:"packages/extension-api/src/extension-api.d.ts:2854"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2793",children:"packages/extension-api/src/extension-api.d.ts:2793"})})]})}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 diff --git a/assets/js/14ae68e7.43b6b40e.js b/assets/js/14ae68e7.e35a2811.js similarity index 78% rename from assets/js/14ae68e7.43b6b40e.js rename to assets/js/14ae68e7.e35a2811.js index b2db4c88643..68e48ad7dd9 100644 --- a/assets/js/14ae68e7.43b6b40e.js +++ b/assets/js/14ae68e7.e35a2811.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60574],{42761:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var i=s(24246),t=s(71670);const c={},o="Interface: EndpointIPAMConfig",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2573",children:"packages/extension-api/src/extension-api.d.ts:2573"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2575",children:"packages/extension-api/src/extension-api.d.ts:2575"})})]})}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:()=>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([[60574],{42761:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2573",children:"packages/extension-api/src/extension-api.d.ts:2573"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2574",children:"packages/extension-api/src/extension-api.d.ts:2574"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2575",children:"packages/extension-api/src/extension-api.d.ts:2575"})})]})}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.a7140e71.js b/assets/js/1515c895.f778edae.js similarity index 83% rename from assets/js/1515c895.a7140e71.js rename to assets/js/1515c895.f778edae.js index 6ee56c3a6c8..151db376bc6 100644 --- a/assets/js/1515c895.a7140e71.js +++ b/assets/js/1515c895.f778edae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{86522:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4275",children:"packages/extension-api/src/extension-api.d.ts:4275"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38134],{86522:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4275",children:"packages/extension-api/src/extension-api.d.ts:4275"})})]})}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 diff --git a/assets/js/160cb329.e463cb1a.js b/assets/js/160cb329.3b3f725b.js similarity index 77% rename from assets/js/160cb329.e463cb1a.js rename to assets/js/160cb329.3b3f725b.js index 5ee30a7bf8b..f880dc86533 100644 --- a/assets/js/160cb329.e463cb1a.js +++ b/assets/js/160cb329.3b3f725b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{2227:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=t(24246),s=t(71670);const c={},i="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L307",children:"packages/extension-api/src/extension-api.d.ts:307"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L306",children:"packages/extension-api/src/extension-api.d.ts:306"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})})]})}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:()=>i});var r=t(27378);const s={},c=r.createContext(s);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(s):e.components||s:i(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3984],{2227:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var r=t(24246),s=t(71670);const i={},o="Interface: ProviderDetectionCheck",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L307",children:"packages/extension-api/src/extension-api.d.ts:307"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L306",children:"packages/extension-api/src/extension-api.d.ts:306"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L308",children:"packages/extension-api/src/extension-api.d.ts:308"})})]})}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:()=>c,a:()=>o});var r=t(27378);const s={},i=r.createContext(s);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(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/164937d2.e5ee911b.js b/assets/js/164937d2.345525c0.js similarity index 93% rename from assets/js/164937d2.e5ee911b.js rename to assets/js/164937d2.345525c0.js index 6997744d785..21fa13b60c0 100644 --- a/assets/js/164937d2.e5ee911b.js +++ b/assets/js/164937d2.345525c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5477],{64010:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4352",children:"packages/extension-api/src/extension-api.d.ts:4352"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4347",children:"packages/extension-api/src/extension-api.d.ts:4347"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4334",children:"packages/extension-api/src/extension-api.d.ts:4334"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4341",children:"packages/extension-api/src/extension-api.d.ts:4341"})})]})}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],{64010:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4352",children:"packages/extension-api/src/extension-api.d.ts:4352"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4347",children:"packages/extension-api/src/extension-api.d.ts:4347"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4334",children:"packages/extension-api/src/extension-api.d.ts:4334"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4341",children:"packages/extension-api/src/extension-api.d.ts:4341"})})]})}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.283a8b0f.js b/assets/js/16914cba.9675a6c0.js similarity index 98% rename from assets/js/16914cba.283a8b0f.js rename to assets/js/16914cba.9675a6c0.js index 4739585953a..984ca13479a 100644 --- a/assets/js/16914cba.283a8b0f.js +++ b/assets/js/16914cba.9675a6c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64315],{57276:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3362",children:"packages/extension-api/src/extension-api.d.ts:3362"})})]})}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],{57276:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3362",children:"packages/extension-api/src/extension-api.d.ts:3362"})})]})}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.a4d71ae9.js b/assets/js/17612ae7.efac6849.js similarity index 83% rename from assets/js/17612ae7.a4d71ae9.js rename to assets/js/17612ae7.efac6849.js index 434c8bc970d..f814ae883d6 100644 --- a/assets/js/17612ae7.a4d71ae9.js +++ b/assets/js/17612ae7.efac6849.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{72267:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3450",children:"packages/extension-api/src/extension-api.d.ts:3450"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97767],{72267:(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: deleteImage()",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3450",children:"packages/extension-api/src/extension-api.d.ts:3450"})})]})}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/17d2ebc8.8cccab86.js b/assets/js/17d2ebc8.11a563bc.js similarity index 77% rename from assets/js/17d2ebc8.8cccab86.js rename to assets/js/17d2ebc8.11a563bc.js index 194aac3fb03..96bce40a323 100644 --- a/assets/js/17d2ebc8.8cccab86.js +++ b/assets/js/17d2ebc8.11a563bc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14142],{89533:(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="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2482",children:"packages/extension-api/src/extension-api.d.ts:2482"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2481",children:"packages/extension-api/src/extension-api.d.ts:2481"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2480",children:"packages/extension-api/src/extension-api.d.ts:2480"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2479",children:"packages/extension-api/src/extension-api.d.ts:2479"})})]})}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([[14142],{89533:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2482",children:"packages/extension-api/src/extension-api.d.ts:2482"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2481",children:"packages/extension-api/src/extension-api.d.ts:2481"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2480",children:"packages/extension-api/src/extension-api.d.ts:2480"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2479",children:"packages/extension-api/src/extension-api.d.ts:2479"})})]})}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 diff --git a/assets/js/180d0c5f.deae8a3f.js b/assets/js/180d0c5f.f0ea5db2.js similarity index 83% rename from assets/js/180d0c5f.deae8a3f.js rename to assets/js/180d0c5f.f0ea5db2.js index 634347772e9..9bf888b6816 100644 --- a/assets/js/180d0c5f.deae8a3f.js +++ b/assets/js/180d0c5f.f0ea5db2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{21101:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3627",children:"packages/extension-api/src/extension-api.d.ts:3627"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51499],{21101:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3627",children:"packages/extension-api/src/extension-api.d.ts:3627"})})]})}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 diff --git a/assets/js/185c52e7.c1f82c3a.js b/assets/js/185c52e7.c1f82c3a.js deleted file mode 100644 index 97146a8cafc..00000000000 --- a/assets/js/185c52e7.c1f82c3a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{36918:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var c=s(24246),i=s(71670);const r={},t="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"}},a={},d=[{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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-volumecreateresponseinfo",children:"Interface: VolumeCreateResponseInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"createdat",children:"CreatedAt?"}),"\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:"CreatedAt"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3253",children:"packages/extension-api/src/extension-api.d.ts:3253"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Driver"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"label"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3255",children:"packages/extension-api/src/extension-api.d.ts:3255"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3252",children:"packages/extension-api/src/extension-api.d.ts:3252"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Name"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3250",children:"packages/extension-api/src/extension-api.d.ts:3250"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Scope"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3256",children:"packages/extension-api/src/extension-api.d.ts:3256"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"status",children:"Status?"}),"\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:"Status"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3254",children:"packages/extension-api/src/extension-api.d.ts:3254"})})]})}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,s)=>{s.d(n,{Z:()=>o,a:()=>t});var c=s(27378);const i={},r=c.createContext(i);function t(e){const n=c.useContext(r);return c.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),c.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/185c52e7.cc408ba2.js b/assets/js/185c52e7.cc408ba2.js new file mode 100644 index 00000000000..3846dc74224 --- /dev/null +++ b/assets/js/185c52e7.cc408ba2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90051],{36918:(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="Interface: VolumeCreateResponseInfo",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3253",children:"packages/extension-api/src/extension-api.d.ts:3253"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3251",children:"packages/extension-api/src/extension-api.d.ts:3251"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3255",children:"packages/extension-api/src/extension-api.d.ts:3255"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3252",children:"packages/extension-api/src/extension-api.d.ts:3252"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3250",children:"packages/extension-api/src/extension-api.d.ts:3250"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3256",children:"packages/extension-api/src/extension-api.d.ts:3256"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3254",children:"packages/extension-api/src/extension-api.d.ts:3254"})})]})}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/19e69ccd.ad0a86d7.js b/assets/js/19e69ccd.0c039829.js similarity index 78% rename from assets/js/19e69ccd.ad0a86d7.js rename to assets/js/19e69ccd.0c039829.js index 8933372c4e1..562e745cf27 100644 --- a/assets/js/19e69ccd.ad0a86d7.js +++ b/assets/js/19e69ccd.0c039829.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{56826:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2980",children:"packages/extension-api/src/extension-api.d.ts:2980"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2982",children:"packages/extension-api/src/extension-api.d.ts:2982"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2983",children:"packages/extension-api/src/extension-api.d.ts:2983"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76091],{56826:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2980",children:"packages/extension-api/src/extension-api.d.ts:2980"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2982",children:"packages/extension-api/src/extension-api.d.ts:2982"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2981",children:"packages/extension-api/src/extension-api.d.ts:2981"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2983",children:"packages/extension-api/src/extension-api.d.ts:2983"})})]})}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 diff --git a/assets/js/1a906644.6aafea8c.js b/assets/js/1a906644.fd7bc125.js similarity index 86% rename from assets/js/1a906644.6aafea8c.js rename to assets/js/1a906644.fd7bc125.js index c5c2ada1c0f..de38882eece 100644 --- a/assets/js/1a906644.6aafea8c.js +++ b/assets/js/1a906644.fd7bc125.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{67681:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3505",children:"packages/extension-api/src/extension-api.d.ts:3505"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52525],{67681:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3505",children:"packages/extension-api/src/extension-api.d.ts:3505"})})]})}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 diff --git a/assets/js/1dfee34e.6d32db92.js b/assets/js/1dfee34e.6d32db92.js new file mode 100644 index 00000000000..2115c465027 --- /dev/null +++ b/assets/js/1dfee34e.6d32db92.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{93686:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>t,toc:()=>a});var o=s(24246),c=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,c.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"class-cancellationtokensource",children:"Class: CancellationTokenSource"}),"\n",(0,o.jsx)(n.h2,{id:"constructors",children:"Constructors"}),"\n",(0,o.jsx)(n.h3,{id:"new-cancellationtokensource",children:"new CancellationTokenSource()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"new CancellationTokenSource"}),"(): ",(0,o.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,o.jsx)(n.code,{children:"CancellationTokenSource"})})]}),"\n"]}),"\n",(0,o.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.a,{href:"/api/classes/CancellationTokenSource",children:(0,o.jsx)(n.code,{children:"CancellationTokenSource"})})}),"\n",(0,o.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,o.jsx)(n.h3,{id:"token",children:"token"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"token"}),": ",(0,o.jsx)(n.a,{href:"/api/interfaces/CancellationToken",children:(0,o.jsx)(n.code,{children:"CancellationToken"})})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"The cancellation token of this source."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L909",children:"packages/extension-api/src/extension-api.d.ts:909"})}),"\n",(0,o.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,o.jsx)(n.h3,{id:"cancel",children:"cancel()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"cancel"}),"(): ",(0,o.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Signal cancellation on the token."}),"\n",(0,o.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"void"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L914",children:"packages/extension-api/src/extension-api.d.ts:914"})}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"dispose",children:"dispose()"}),"\n",(0,o.jsxs)(n.blockquote,{children:["\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.strong,{children:"dispose"}),"(): ",(0,o.jsx)(n.code,{children:"void"})]}),"\n"]}),"\n",(0,o.jsx)(n.p,{children:"Dispose object and free resources."}),"\n",(0,o.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,o.jsx)(n.p,{children:(0,o.jsx)(n.code,{children:"void"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L919",children:"packages/extension-api/src/extension-api.d.ts:919"})})]})}function u(e={}){const{wrapper:n}={...(0,c.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:()=>t,a:()=>r});var o=s(27378);const c={},i=o.createContext(c);function r(e){const n=o.useContext(i);return o.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),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1dfee34e.c551b243.js b/assets/js/1dfee34e.c551b243.js deleted file mode 100644 index e8576ed412e..00000000000 --- a/assets/js/1dfee34e.c551b243.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[15554],{93686:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L909",children:"packages/extension-api/src/extension-api.d.ts:909"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L914",children:"packages/extension-api/src/extension-api.d.ts:914"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L919",children:"packages/extension-api/src/extension-api.d.ts:919"})})]})}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.90b62e86.js b/assets/js/1ee92283.f9c4979b.js similarity index 91% rename from assets/js/1ee92283.90b62e86.js rename to assets/js/1ee92283.f9c4979b.js index 2d62cdc12d3..7ed5d07be13 100644 --- a/assets/js/1ee92283.90b62e86.js +++ b/assets/js/1ee92283.f9c4979b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65144],{4226:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L581",children:"packages/extension-api/src/extension-api.d.ts:581"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L566",children:"packages/extension-api/src/extension-api.d.ts:566"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L576",children:"packages/extension-api/src/extension-api.d.ts:576"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L565",children:"packages/extension-api/src/extension-api.d.ts:565"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L592",children:"packages/extension-api/src/extension-api.d.ts:592"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L572",children:"packages/extension-api/src/extension-api.d.ts:572"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L560",children:"packages/extension-api/src/extension-api.d.ts:560"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L562",children:"packages/extension-api/src/extension-api.d.ts:562"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L550",children:"packages/extension-api/src/extension-api.d.ts:550"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L551",children:"packages/extension-api/src/extension-api.d.ts:551"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L557",children:"packages/extension-api/src/extension-api.d.ts:557"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L544",children:"packages/extension-api/src/extension-api.d.ts:544"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L573",children:"packages/extension-api/src/extension-api.d.ts:573"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})})]})}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],{4226:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L581",children:"packages/extension-api/src/extension-api.d.ts:581"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L566",children:"packages/extension-api/src/extension-api.d.ts:566"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L576",children:"packages/extension-api/src/extension-api.d.ts:576"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L578",children:"packages/extension-api/src/extension-api.d.ts:578"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L565",children:"packages/extension-api/src/extension-api.d.ts:565"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L592",children:"packages/extension-api/src/extension-api.d.ts:592"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L569",children:"packages/extension-api/src/extension-api.d.ts:569"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L574",children:"packages/extension-api/src/extension-api.d.ts:574"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L567",children:"packages/extension-api/src/extension-api.d.ts:567"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L572",children:"packages/extension-api/src/extension-api.d.ts:572"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L588",children:"packages/extension-api/src/extension-api.d.ts:588"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L564",children:"packages/extension-api/src/extension-api.d.ts:564"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L560",children:"packages/extension-api/src/extension-api.d.ts:560"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L562",children:"packages/extension-api/src/extension-api.d.ts:562"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L549",children:"packages/extension-api/src/extension-api.d.ts:549"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L554",children:"packages/extension-api/src/extension-api.d.ts:554"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L550",children:"packages/extension-api/src/extension-api.d.ts:550"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L551",children:"packages/extension-api/src/extension-api.d.ts:551"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L557",children:"packages/extension-api/src/extension-api.d.ts:557"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L540",children:"packages/extension-api/src/extension-api.d.ts:540"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L544",children:"packages/extension-api/src/extension-api.d.ts:544"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L585",children:"packages/extension-api/src/extension-api.d.ts:585"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L568",children:"packages/extension-api/src/extension-api.d.ts:568"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L573",children:"packages/extension-api/src/extension-api.d.ts:573"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L589",children:"packages/extension-api/src/extension-api.d.ts:589"})})]})}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.3feaeb32.js b/assets/js/1fbe0675.536f6d3e.js similarity index 84% rename from assets/js/1fbe0675.3feaeb32.js rename to assets/js/1fbe0675.536f6d3e.js index c66cb70bd70..557f2da29ef 100644 --- a/assets/js/1fbe0675.3feaeb32.js +++ b/assets/js/1fbe0675.536f6d3e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{68579:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1491",children:"packages/extension-api/src/extension-api.d.ts:1491"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39613],{68579:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1491",children:"packages/extension-api/src/extension-api.d.ts:1491"})})]})}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 diff --git a/assets/js/1fc83a28.90983a76.js b/assets/js/1fc83a28.90983a76.js deleted file mode 100644 index 37344057d91..00000000000 --- a/assets/js/1fc83a28.90983a76.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{9146:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var c=s(24246),i=s(71670);const t={},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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-authenticationsession",children:"Interface: AuthenticationSession"}),"\n",(0,c.jsx)(n.p,{children:"Represents a session of a currently logged in user."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"accesstoken",children:"accessToken"}),"\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:"accessToken"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The access token."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3521",children:"packages/extension-api/src/extension-api.d.ts:3521"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"account",children:"account"}),"\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:"account"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/AuthenticationSessionAccountInformation",children:(0,c.jsx)(n.code,{children:"AuthenticationSessionAccountInformation"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The account associated with the session."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3526",children:"packages/extension-api/src/extension-api.d.ts:3526"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"id"}),"\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:"id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The identifier of the authentication session."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3516",children:"packages/extension-api/src/extension-api.d.ts:3516"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"scopes",children:"scopes"}),"\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:"scopes"}),": readonly ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["The permissions granted by the session's access token. Available scopes\nare defined by the ",(0,c.jsx)(n.a,{href:"#AuthenticationProvider",children:"AuthenticationProvider"}),"."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3532",children:"packages/extension-api/src/extension-api.d.ts:3532"})})]})}function l(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(h,{...e})}):h(e)}},71670:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>o});var c=s(27378);const i={},t=c.createContext(i);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(i):e.components||i:o(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1fc83a28.cfa83aae.js b/assets/js/1fc83a28.cfa83aae.js new file mode 100644 index 00000000000..43026c58641 --- /dev/null +++ b/assets/js/1fc83a28.cfa83aae.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70633],{9146:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3521",children:"packages/extension-api/src/extension-api.d.ts:3521"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3526",children:"packages/extension-api/src/extension-api.d.ts:3526"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3516",children:"packages/extension-api/src/extension-api.d.ts:3516"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3532",children:"packages/extension-api/src/extension-api.d.ts:3532"})})]})}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.c37e66ef.js b/assets/js/22e2140b.5683dc11.js similarity index 85% rename from assets/js/22e2140b.c37e66ef.js rename to assets/js/22e2140b.5683dc11.js index 2234a34e7dd..3d779b286dc 100644 --- a/assets/js/22e2140b.c37e66ef.js +++ b/assets/js/22e2140b.5683dc11.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24260],{47227:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})})]})}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],{47227:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L276",children:"packages/extension-api/src/extension-api.d.ts:276"})})]})}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.5d4a2ef4.js b/assets/js/2340b3ee.5d4a2ef4.js new file mode 100644 index 00000000000..1ed7be658ee --- /dev/null +++ b/assets/js/2340b3ee.5d4a2ef4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{37099:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3948",children:"packages/extension-api/src/extension-api.d.ts:3948"})})]})}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.ea4bef3f.js b/assets/js/2340b3ee.ea4bef3f.js deleted file mode 100644 index c60a8d54546..00000000000 --- a/assets/js/2340b3ee.ea4bef3f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20205],{37099:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3948",children:"packages/extension-api/src/extension-api.d.ts:3948"})})]})}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.1eb149d0.js b/assets/js/23a8e291.9ccc0eba.js similarity index 96% rename from assets/js/23a8e291.1eb149d0.js rename to assets/js/23a8e291.9ccc0eba.js index 4919968a852..82a6807ea7c 100644 --- a/assets/js/23a8e291.1eb149d0.js +++ b/assets/js/23a8e291.9ccc0eba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43274],{87634:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L829",children:"packages/extension-api/src/extension-api.d.ts:829"})})]})}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],{87634:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L829",children:"packages/extension-api/src/extension-api.d.ts:829"})})]})}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.73bea534.js b/assets/js/24dadce3.331a26e4.js similarity index 53% rename from assets/js/24dadce3.73bea534.js rename to assets/js/24dadce3.331a26e4.js index 2d5d711e139..2386e089935 100644 --- a/assets/js/24dadce3.73bea534.js +++ b/assets/js/24dadce3.331a26e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{30172:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70595],{30172:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L339",children:"packages/extension-api/src/extension-api.d.ts:339"})})]})}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 diff --git a/assets/js/254d0ff5.0566da11.js b/assets/js/254d0ff5.00c8fc0a.js similarity index 95% rename from assets/js/254d0ff5.0566da11.js rename to assets/js/254d0ff5.00c8fc0a.js index 3a83baa52f8..4cc29d963ba 100644 --- a/assets/js/254d0ff5.0566da11.js +++ b/assets/js/254d0ff5.00c8fc0a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60810],{37340:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L535",children:"packages/extension-api/src/extension-api.d.ts:535"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L536",children:"packages/extension-api/src/extension-api.d.ts:536"})})]})}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],{37340:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L535",children:"packages/extension-api/src/extension-api.d.ts:535"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L536",children:"packages/extension-api/src/extension-api.d.ts:536"})})]})}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.84443554.js b/assets/js/271ff0d1.6967500a.js similarity index 96% rename from assets/js/271ff0d1.84443554.js rename to assets/js/271ff0d1.6967500a.js index 7040100db6e..07cedd5c802 100644 --- a/assets/js/271ff0d1.84443554.js +++ b/assets/js/271ff0d1.6967500a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86335],{89714:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1827",children:"packages/extension-api/src/extension-api.d.ts:1827"})})]})}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],{89714:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1827",children:"packages/extension-api/src/extension-api.d.ts:1827"})})]})}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.46749022.js b/assets/js/280646e4.089c2835.js similarity index 92% rename from assets/js/280646e4.46749022.js rename to assets/js/280646e4.089c2835.js index bf8ebd26291..3765b2a7fec 100644 --- a/assets/js/280646e4.46749022.js +++ b/assets/js/280646e4.089c2835.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24726],{11024:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2327",children:"packages/extension-api/src/extension-api.d.ts:2327"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2323",children:"packages/extension-api/src/extension-api.d.ts:2323"})})]})}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],{11024:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2327",children:"packages/extension-api/src/extension-api.d.ts:2327"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2331",children:"packages/extension-api/src/extension-api.d.ts:2331"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2323",children:"packages/extension-api/src/extension-api.d.ts:2323"})})]})}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.94d3697b.js b/assets/js/2bb2c1cd.a308c466.js similarity index 97% rename from assets/js/2bb2c1cd.94d3697b.js rename to assets/js/2bb2c1cd.a308c466.js index b7845b71a34..66741521ea3 100644 --- a/assets/js/2bb2c1cd.94d3697b.js +++ b/assets/js/2bb2c1cd.a308c466.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74340],{8108:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2650",children:"packages/extension-api/src/extension-api.d.ts:2650"})})]})}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],{8108:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2650",children:"packages/extension-api/src/extension-api.d.ts:2650"})})]})}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.f85eed1e.js b/assets/js/2cb13d6d.4719197f.js similarity index 73% rename from assets/js/2cb13d6d.f85eed1e.js rename to assets/js/2cb13d6d.4719197f.js index ff3f3996e77..3d1807e180c 100644 --- a/assets/js/2cb13d6d.f85eed1e.js +++ b/assets/js/2cb13d6d.4719197f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{69729:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var s=t(24246),r=t(71670);const i={},c="Interface: BlkioStatEntry",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2884",children:"packages/extension-api/src/extension-api.d.ts:2884"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2885",children:"packages/extension-api/src/extension-api.d.ts:2885"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})})]})}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:()=>o,a:()=>c});var s=t(27378);const r={},i=s.createContext(r);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(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86528],{69729:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2884",children:"packages/extension-api/src/extension-api.d.ts:2884"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2885",children:"packages/extension-api/src/extension-api.d.ts:2885"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2886",children:"packages/extension-api/src/extension-api.d.ts:2886"})})]})}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/3109d9d2.ae28f79d.js b/assets/js/3109d9d2.8839301e.js similarity index 94% rename from assets/js/3109d9d2.ae28f79d.js rename to assets/js/3109d9d2.8839301e.js index c195916945b..96c0229782f 100644 --- a/assets/js/3109d9d2.ae28f79d.js +++ b/assets/js/3109d9d2.8839301e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3745],{61123:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1846",children:"packages/extension-api/src/extension-api.d.ts:1846"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1874",children:"packages/extension-api/src/extension-api.d.ts:1874"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1888",children:"packages/extension-api/src/extension-api.d.ts:1888"})})]})}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],{61123:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1846",children:"packages/extension-api/src/extension-api.d.ts:1846"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1860",children:"packages/extension-api/src/extension-api.d.ts:1860"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1874",children:"packages/extension-api/src/extension-api.d.ts:1874"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1888",children:"packages/extension-api/src/extension-api.d.ts:1888"})})]})}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.712a8223.js b/assets/js/3132913e.2f922359.js similarity index 77% rename from assets/js/3132913e.712a8223.js rename to assets/js/3132913e.2f922359.js index 831a3f763e4..eb6cd0594f9 100644 --- a/assets/js/3132913e.712a8223.js +++ b/assets/js/3132913e.2f922359.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68732],{83659:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const r={},c="Interface: SaveDialogOptions",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1666",children:"packages/extension-api/src/extension-api.d.ts:1666"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1676",children:"packages/extension-api/src/extension-api.d.ts:1676"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1671",children:"packages/extension-api/src/extension-api.d.ts:1671"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1684",children:"packages/extension-api/src/extension-api.d.ts:1684"})})]})}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:()=>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([[68732],{83659:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1666",children:"packages/extension-api/src/extension-api.d.ts:1666"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1676",children:"packages/extension-api/src/extension-api.d.ts:1676"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1671",children:"packages/extension-api/src/extension-api.d.ts:1671"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1684",children:"packages/extension-api/src/extension-api.d.ts:1684"})})]})}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 diff --git a/assets/js/35300761.4821b8f0.js b/assets/js/35300761.4821b8f0.js new file mode 100644 index 00000000000..ca0aeec8f54 --- /dev/null +++ b/assets/js/35300761.4821b8f0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{5052:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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 diff --git a/assets/js/35300761.ba9be465.js b/assets/js/35300761.ba9be465.js deleted file mode 100644 index f22707c40ae..00000000000 --- a/assets/js/35300761.ba9be465.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96120],{5052:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var s=c(24246),i=c(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,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-menuitem",children:"Interface: MenuItem"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"checked",children:"checked?"}),"\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:"checked"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Should only be specified for ",(0,s.jsx)(n.code,{children:"checkbox"})," or ",(0,s.jsx)(n.code,{children:"radio"})," type menu items."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L79",children:"packages/extension-api/src/extension-api.d.ts:79"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enabled",children:"enabled?"}),"\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:"enabled"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If false, the menu item will be greyed out and unclickable."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L71",children:"packages/extension-api/src/extension-api.d.ts:71"})}),"\n",(0,s.jsx)(n.hr,{}),"\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-2",children:"Source"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L67",children:"packages/extension-api/src/extension-api.d.ts:67"})}),"\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.p,{children:"Unique within a single menu. Should be same as commandId for handler"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L62",children:"packages/extension-api/src/extension-api.d.ts:62"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"label",children:"label?"}),"\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:"label"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L65",children:"packages/extension-api/src/extension-api.d.ts:65"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"submenu",children:"submenu?"}),"\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:"submenu"}),": ",(0,s.jsx)(n.a,{href:"/api/interfaces/MenuItem",children:(0,s.jsx)(n.code,{children:"MenuItem"})}),"[]"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L81",children:"packages/extension-api/src/extension-api.d.ts:81"})}),"\n",(0,s.jsx)(n.hr,{}),"\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:'"normal"'})," | ",(0,s.jsx)(n.code,{children:'"separator"'})," | ",(0,s.jsx)(n.code,{children:'"submenu"'})," | ",(0,s.jsx)(n.code,{children:'"checkbox"'})," | ",(0,s.jsx)(n.code,{children:'"radio"'})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L64",children:"packages/extension-api/src/extension-api.d.ts:64"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"visible",children:"visible?"}),"\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:"visible"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"If false, the menu item will be entirely hidden."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},71670:(e,n,c)=>{c.d(n,{Z:()=>t,a:()=>o});var s=c(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 t(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/3866940b.10ba540e.js b/assets/js/3866940b.b37d600b.js similarity index 80% rename from assets/js/3866940b.10ba540e.js rename to assets/js/3866940b.b37d600b.js index ae0a3ddf5ae..2fa67f90c12 100644 --- a/assets/js/3866940b.10ba540e.js +++ b/assets/js/3866940b.b37d600b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{9215:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L301",children:"packages/extension-api/src/extension-api.d.ts:301"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6082],{9215:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L302",children:"packages/extension-api/src/extension-api.d.ts:302"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L301",children:"packages/extension-api/src/extension-api.d.ts:301"})})]})}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 diff --git a/assets/js/39ae3791.becaae5c.js b/assets/js/39ae3791.0ed1c7c5.js similarity index 87% rename from assets/js/39ae3791.becaae5c.js rename to assets/js/39ae3791.0ed1c7c5.js index f9eb5e45721..1c6aec744b6 100644 --- a/assets/js/39ae3791.becaae5c.js +++ b/assets/js/39ae3791.0ed1c7c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[955],{82687:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});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={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L294",children:"packages/extension-api/src/extension-api.d.ts:294"})})]})}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([[955],{82687:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L292",children:"packages/extension-api/src/extension-api.d.ts:292"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L293",children:"packages/extension-api/src/extension-api.d.ts:293"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L295",children:"packages/extension-api/src/extension-api.d.ts:295"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L294",children:"packages/extension-api/src/extension-api.d.ts:294"})})]})}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 diff --git a/assets/js/3a38a610.ccb4d594.js b/assets/js/3a38a610.843d1298.js similarity index 81% rename from assets/js/3a38a610.ccb4d594.js rename to assets/js/3a38a610.843d1298.js index 4e85da144f5..8fade21c00b 100644 --- a/assets/js/3a38a610.ccb4d594.js +++ b/assets/js/3a38a610.843d1298.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91721],{12426:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1983",children:"packages/extension-api/src/extension-api.d.ts:1983"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1978",children:"packages/extension-api/src/extension-api.d.ts:1978"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1985",children:"packages/extension-api/src/extension-api.d.ts:1985"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1984",children:"packages/extension-api/src/extension-api.d.ts:1984"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1982",children:"packages/extension-api/src/extension-api.d.ts:1982"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1975",children:"packages/extension-api/src/extension-api.d.ts:1975"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1977",children:"packages/extension-api/src/extension-api.d.ts:1977"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1976",children:"packages/extension-api/src/extension-api.d.ts:1976"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1979",children:"packages/extension-api/src/extension-api.d.ts:1979"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1980",children:"packages/extension-api/src/extension-api.d.ts:1980"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1988",children:"packages/extension-api/src/extension-api.d.ts:1988"})})]})}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([[91721],{12426:(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: 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,r.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1983",children:"packages/extension-api/src/extension-api.d.ts:1983"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1978",children:"packages/extension-api/src/extension-api.d.ts:1978"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1985",children:"packages/extension-api/src/extension-api.d.ts:1985"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1984",children:"packages/extension-api/src/extension-api.d.ts:1984"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1974",children:"packages/extension-api/src/extension-api.d.ts:1974"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1982",children:"packages/extension-api/src/extension-api.d.ts:1982"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1975",children:"packages/extension-api/src/extension-api.d.ts:1975"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1977",children:"packages/extension-api/src/extension-api.d.ts:1977"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1976",children:"packages/extension-api/src/extension-api.d.ts:1976"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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-10",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1979",children:"packages/extension-api/src/extension-api.d.ts:1979"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1980",children:"packages/extension-api/src/extension-api.d.ts:1980"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1988",children:"packages/extension-api/src/extension-api.d.ts:1988"})})]})}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/3ba80b69.ddc36861.js b/assets/js/3ba80b69.b441ebc7.js similarity index 91% rename from assets/js/3ba80b69.ddc36861.js rename to assets/js/3ba80b69.b441ebc7.js index 6ba77c5ec48..602ac4dbcb3 100644 --- a/assets/js/3ba80b69.ddc36861.js +++ b/assets/js/3ba80b69.b441ebc7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3408],{60205:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2345",children:"packages/extension-api/src/extension-api.d.ts:2345"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2349",children:"packages/extension-api/src/extension-api.d.ts:2349"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2353",children:"packages/extension-api/src/extension-api.d.ts:2353"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2341",children:"packages/extension-api/src/extension-api.d.ts:2341"})})]})}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],{60205:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2345",children:"packages/extension-api/src/extension-api.d.ts:2345"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2349",children:"packages/extension-api/src/extension-api.d.ts:2349"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2353",children:"packages/extension-api/src/extension-api.d.ts:2353"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2341",children:"packages/extension-api/src/extension-api.d.ts:2341"})})]})}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.c4b7cbc0.js b/assets/js/3e2b82eb.21ac824b.js similarity index 95% rename from assets/js/3e2b82eb.c4b7cbc0.js rename to assets/js/3e2b82eb.21ac824b.js index f01b05623d6..07755b2b4a4 100644 --- a/assets/js/3e2b82eb.c4b7cbc0.js +++ b/assets/js/3e2b82eb.21ac824b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40683],{64994:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4280",children:"packages/extension-api/src/extension-api.d.ts:4280"})})]})}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],{64994:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4280",children:"packages/extension-api/src/extension-api.d.ts:4280"})})]})}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.c5db7e27.js b/assets/js/3f66023b.c5db7e27.js new file mode 100644 index 00000000000..1e27f87eb85 --- /dev/null +++ b/assets/js/3f66023b.c5db7e27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91328:(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: 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,r.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2107",children:"packages/extension-api/src/extension-api.d.ts:2107"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2108",children:"packages/extension-api/src/extension-api.d.ts:2108"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2113",children:"packages/extension-api/src/extension-api.d.ts:2113"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2106",children:"packages/extension-api/src/extension-api.d.ts:2106"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2110",children:"packages/extension-api/src/extension-api.d.ts:2110"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2119",children:"packages/extension-api/src/extension-api.d.ts:2119"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2116",children:"packages/extension-api/src/extension-api.d.ts:2116"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2109",children:"packages/extension-api/src/extension-api.d.ts:2109"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2111",children:"packages/extension-api/src/extension-api.d.ts:2111"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2112",children:"packages/extension-api/src/extension-api.d.ts:2112"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2102",children:"packages/extension-api/src/extension-api.d.ts:2102"})})]})}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 diff --git a/assets/js/3f66023b.fb439bd5.js b/assets/js/3f66023b.fb439bd5.js deleted file mode 100644 index 788d4e30a05..00000000000 --- a/assets/js/3f66023b.fb439bd5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80161],{91328:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-containerinfo",children:"Interface: ContainerInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"command",children:"Command"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Command"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2107",children:"packages/extension-api/src/extension-api.d.ts:2107"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Created"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2108",children:"packages/extension-api/src/extension-api.d.ts:2108"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"hostconfig",children:"HostConfig"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"HostConfig"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"networkmode",children:"NetworkMode"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"NetworkMode"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2113",children:"packages/extension-api/src/extension-api.d.ts:2113"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2103",children:"packages/extension-api/src/extension-api.d.ts:2103"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"image",children:"Image"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Image"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2105",children:"packages/extension-api/src/extension-api.d.ts:2105"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"imageid",children:"ImageID"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"ImageID"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2106",children:"packages/extension-api/src/extension-api.d.ts:2106"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"label"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2110",children:"packages/extension-api/src/extension-api.d.ts:2110"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"mounts",children:"Mounts"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Mounts"}),": ",(0,c.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2119",children:"packages/extension-api/src/extension-api.d.ts:2119"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"names",children:"Names"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Names"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2104",children:"packages/extension-api/src/extension-api.d.ts:2104"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"networksettings",children:"NetworkSettings"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"NetworkSettings"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"networks",children:"Networks"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Networks"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h5,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"networkType"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.a,{href:"/api/interfaces/NetworkInfo",children:(0,c.jsx)(n.code,{children:"NetworkInfo"})})]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2116",children:"packages/extension-api/src/extension-api.d.ts:2116"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ports",children:"Ports"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Ports"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Port",children:(0,c.jsx)(n.code,{children:"Port"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2109",children:"packages/extension-api/src/extension-api.d.ts:2109"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"state",children:"State"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"State"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2111",children:"packages/extension-api/src/extension-api.d.ts:2111"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"status",children:"Status"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Status"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2112",children:"packages/extension-api/src/extension-api.d.ts:2112"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2100",children:"packages/extension-api/src/extension-api.d.ts:2100"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineName"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2101",children:"packages/extension-api/src/extension-api.d.ts:2101"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineType"}),": ",(0,c.jsx)(n.code,{children:'"docker"'})," | ",(0,c.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2102",children:"packages/extension-api/src/extension-api.d.ts:2102"})})]})}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:()=>t,a:()=>o});var c=s(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 t(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/3f797343.b5255e31.js b/assets/js/3f797343.e72379c6.js similarity index 76% rename from assets/js/3f797343.b5255e31.js rename to assets/js/3f797343.e72379c6.js index 393c9ca006f..8e987be90d7 100644 --- a/assets/js/3f797343.b5255e31.js +++ b/assets/js/3f797343.e72379c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{2310:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L521",children:"packages/extension-api/src/extension-api.d.ts:521"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85632],{2310:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L520",children:"packages/extension-api/src/extension-api.d.ts:520"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L521",children:"packages/extension-api/src/extension-api.d.ts:521"})})]})}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 diff --git a/assets/js/40d377be.33ea111e.js b/assets/js/40d377be.683b25ad.js similarity index 74% rename from assets/js/40d377be.33ea111e.js rename to assets/js/40d377be.683b25ad.js index 97f84b71a8a..d65f518e9a5 100644 --- a/assets/js/40d377be.33ea111e.js +++ b/assets/js/40d377be.683b25ad.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{53910:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),c=s(71670);const r={},t="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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L387",children:"packages/extension-api/src/extension-api.d.ts:387"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L386",children:"packages/extension-api/src/extension-api.d.ts:386"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L384",children:"packages/extension-api/src/extension-api.d.ts:384"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})})]})}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,s)=>{s.d(n,{Z:()=>o,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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14077],{53910:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L387",children:"packages/extension-api/src/extension-api.d.ts:387"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L386",children:"packages/extension-api/src/extension-api.d.ts:386"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L384",children:"packages/extension-api/src/extension-api.d.ts:384"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L385",children:"packages/extension-api/src/extension-api.d.ts:385"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L390",children:"packages/extension-api/src/extension-api.d.ts:390"})})]})}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/416d4fcf.7b312fa4.js b/assets/js/416d4fcf.359b26c5.js similarity index 86% rename from assets/js/416d4fcf.7b312fa4.js rename to assets/js/416d4fcf.359b26c5.js index 1bda862edfa..3b370c93d12 100644 --- a/assets/js/416d4fcf.7b312fa4.js +++ b/assets/js/416d4fcf.359b26c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{60855:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var i=t(24246),r=t(71670);const a={},s="Interface: ContainerCreateResult",c={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"}},o={},d=[{value:"Properties",id:"properties",level:2},{value:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",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,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:"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.p,{children:"the engineId where the container is running"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2868",children:"packages/extension-api/src/extension-api.d.ts:2868"})}),"\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.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-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})})]})}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,t)=>{t.d(n,{Z:()=>c,a:()=>s});var i=t(27378);const r={},a=i.createContext(r);function s(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(r):e.components||r:s(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44422],{60855:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=t(24246),r=t(71670);const a={},s="Interface: ContainerCreateResult",o={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:"engineId",id:"engineid",level:3},{value:"Source",id:"source",level:4},{value:"id",id:"id",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,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:"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.p,{children:"the engineId where the container is running"}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2868",children:"packages/extension-api/src/extension-api.d.ts:2868"})}),"\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.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-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2864",children:"packages/extension-api/src/extension-api.d.ts:2864"})})]})}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,t)=>{t.d(n,{Z:()=>o,a:()=>s});var i=t(27378);const r={},a=i.createContext(r);function s(e){const n=i.useContext(a);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:s(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/41b2e801.6a96dd75.js b/assets/js/41b2e801.547632fe.js similarity index 86% rename from assets/js/41b2e801.6a96dd75.js rename to assets/js/41b2e801.547632fe.js index bd76d464061..98cc6e36396 100644 --- a/assets/js/41b2e801.6a96dd75.js +++ b/assets/js/41b2e801.547632fe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35137],{80995:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})})]})}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],{80995:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>o,contentTitle:()=>t,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var s=n(24246),i=n(71670);const a={},t="Function: registerImageCheckerProvider()",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4254",children:"packages/extension-api/src/extension-api.d.ts:4254"})})]})}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:()=>c,a:()=>t});var s=n(27378);const i={},a=s.createContext(i);function t(e){const r=s.useContext(a);return s.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:t(e.components),s.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/423842d7.3c29c470.js b/assets/js/423842d7.8da5c631.js similarity index 96% rename from assets/js/423842d7.3c29c470.js rename to assets/js/423842d7.8da5c631.js index 3fba5252643..d4ac4387845 100644 --- a/assets/js/423842d7.3c29c470.js +++ b/assets/js/423842d7.8da5c631.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27328],{88952:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1954",children:"packages/extension-api/src/extension-api.d.ts:1954"})})]})}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],{88952:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1954",children:"packages/extension-api/src/extension-api.d.ts:1954"})})]})}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.8422e8d5.js b/assets/js/42b67a8e.fb7ca19b.js similarity index 72% rename from assets/js/42b67a8e.8422e8d5.js rename to assets/js/42b67a8e.fb7ca19b.js index 6fbe7dfef74..f809070d23e 100644 --- a/assets/js/42b67a8e.8422e8d5.js +++ b/assets/js/42b67a8e.fb7ca19b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{38472:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var s=n(24246),r=n(71670);const o={},c="Interface: HostRestartPolicy",i={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2200",children:"packages/extension-api/src/extension-api.d.ts:2200"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2199",children:"packages/extension-api/src/extension-api.d.ts:2199"})})]})}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:()=>i,a:()=>c});var s=n(27378);const r={},o=s.createContext(r);function c(e){const t=s.useContext(o);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(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54774],{38472:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2200",children:"packages/extension-api/src/extension-api.d.ts:2200"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2199",children:"packages/extension-api/src/extension-api.d.ts:2199"})})]})}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 diff --git a/assets/js/43be69c9.a7dd71c8.js b/assets/js/43be69c9.a7dd71c8.js new file mode 100644 index 00000000000..b5853b297b8 --- /dev/null +++ b/assets/js/43be69c9.a7dd71c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{48168:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>a});var s=n(24246),t=n(71670);const c={},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"}},d={},a=[{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,t.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1142",children:"packages/extension-api/src/extension-api.d.ts:1142"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1152",children:"packages/extension-api/src/extension-api.d.ts:1152"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1114",children:"packages/extension-api/src/extension-api.d.ts:1114"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1122",children:"packages/extension-api/src/extension-api.d.ts:1122"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1106",children:"packages/extension-api/src/extension-api.d.ts:1106"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1100",children:"packages/extension-api/src/extension-api.d.ts:1100"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1135",children:"packages/extension-api/src/extension-api.d.ts:1135"})})]})}function h(e={}){const{wrapper:i}={...(0,t.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 t={},c=s.createContext(t);function r(e){const i=s.useContext(c);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(t):e.components||t:r(e.components),s.createElement(c.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43be69c9.e2105266.js b/assets/js/43be69c9.e2105266.js deleted file mode 100644 index 3cdea8aa197..00000000000 --- a/assets/js/43be69c9.e2105266.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86661],{48168:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var c=n(24246),s=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,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(i.h1,{id:"interface-quickpickitem",children:"Interface: QuickPickItem"}),"\n",(0,c.jsx)(i.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,c.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(i.h3,{id:"alwaysshow",children:"alwaysShow?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"alwaysShow"}),": ",(0,c.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(i.p,{children:"Always show this item."}),"\n",(0,c.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,c.jsx)(i.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1142",children:"packages/extension-api/src/extension-api.d.ts:1142"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"buttons",children:"buttons?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"buttons"}),": readonly ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickInputButton",children:(0,c.jsx)(i.code,{children:"QuickInputButton"})}),"[]"]}),"\n"]}),"\n",(0,c.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,c.jsx)(i.a,{href:"/api/namespaces/window/functions/showQuickPick",children:"showQuickPick()"})," API."]}),"\n",(0,c.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,c.jsx)(i.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1152",children:"packages/extension-api/src/extension-api.d.ts:1152"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"description",children:"description?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"description"}),": ",(0,c.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,c.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,c.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,c.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,c.jsx)(i.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1114",children:"packages/extension-api/src/extension-api.d.ts:1114"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"detail",children:"detail?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"detail"}),": ",(0,c.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,c.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,c.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,c.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,c.jsx)(i.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1122",children:"packages/extension-api/src/extension-api.d.ts:1122"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"kind",children:"kind?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"kind"}),": ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind",children:(0,c.jsx)(i.code,{children:"QuickPickItemKind"})})]}),"\n"]}),"\n",(0,c.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,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#default",children:"QuickPickItemKind.Default"}),"."]}),"\n",(0,c.jsx)(i.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1106",children:"packages/extension-api/src/extension-api.d.ts:1106"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"label",children:"label"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.strong,{children:"label"}),": ",(0,c.jsx)(i.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(i.p,{children:["A human-readable string which is rendered prominent. Supports rendering of ThemeIcon theme icons via\nthe ",(0,c.jsx)(i.code,{children:"$()"}),"-syntax."]}),"\n",(0,c.jsx)(i.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1100",children:"packages/extension-api/src/extension-api.d.ts:1100"})}),"\n",(0,c.jsx)(i.hr,{}),"\n",(0,c.jsx)(i.h3,{id:"picked",children:"picked?"}),"\n",(0,c.jsxs)(i.blockquote,{children:["\n",(0,c.jsxs)(i.p,{children:[(0,c.jsx)(i.code,{children:"optional"})," ",(0,c.jsx)(i.strong,{children:"picked"}),": ",(0,c.jsx)(i.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(i.p,{children:["Optional flag indicating if this item is picked initially. This is only honored when using\nthe ",(0,c.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,c.jsx)(i.em,{children:"Note:"})," This is only honored when the picker allows multiple selections.)"]}),"\n",(0,c.jsx)(i.h4,{id:"see",children:"See"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickOptions#canpickmany",children:"QuickPickOptions.canPickMany"})}),"\n",(0,c.jsxs)(i.p,{children:["Note: this property is ignored when ",(0,c.jsx)(i.a,{href:"/api/interfaces/QuickPickItem#kind",children:"kind"})," is set to ",(0,c.jsx)(i.a,{href:"/api/enumerations/QuickPickItemKind#separator",children:"QuickPickItemKind.Separator"})]}),"\n",(0,c.jsx)(i.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(i.p,{children:(0,c.jsx)(i.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1135",children:"packages/extension-api/src/extension-api.d.ts:1135"})})]})}function h(e={}){const{wrapper:i}={...(0,s.a)(),...e.components};return i?(0,c.jsx)(i,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,i,n)=>{n.d(i,{Z:()=>o,a:()=>r});var c=n(27378);const s={},t=c.createContext(s);function r(e){const i=c.useContext(t);return c.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(s):e.components||s:r(e.components),c.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44287967.b9368bb8.js b/assets/js/44287967.6c5e62f6.js similarity index 98% rename from assets/js/44287967.b9368bb8.js rename to assets/js/44287967.6c5e62f6.js index 45099339bb7..676b2c2e53d 100644 --- a/assets/js/44287967.b9368bb8.js +++ b/assets/js/44287967.6c5e62f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49867],{19142:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3341",children:"packages/extension-api/src/extension-api.d.ts:3341"})})]})}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],{19142:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3341",children:"packages/extension-api/src/extension-api.d.ts:3341"})})]})}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.e07ec3d8.js b/assets/js/456c0e28.3b09db76.js similarity index 92% rename from assets/js/456c0e28.e07ec3d8.js rename to assets/js/456c0e28.3b09db76.js index aa6a5b61f8b..6ef3760caed 100644 --- a/assets/js/456c0e28.e07ec3d8.js +++ b/assets/js/456c0e28.3b09db76.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33279],{3494:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2155",children:"packages/extension-api/src/extension-api.d.ts:2155"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2156",children:"packages/extension-api/src/extension-api.d.ts:2156"})})]})}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],{3494:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2154",children:"packages/extension-api/src/extension-api.d.ts:2154"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2155",children:"packages/extension-api/src/extension-api.d.ts:2155"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2156",children:"packages/extension-api/src/extension-api.d.ts:2156"})})]})}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.5760588b.js b/assets/js/46669adc.fc185d78.js similarity index 78% rename from assets/js/46669adc.5760588b.js rename to assets/js/46669adc.fc185d78.js index 34dd07bce9e..0bea6939eff 100644 --- a/assets/js/46669adc.5760588b.js +++ b/assets/js/46669adc.fc185d78.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{60964:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var t=r(24246),c=r(71670);const s={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L447",children:"packages/extension-api/src/extension-api.d.ts:447"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L446",children:"packages/extension-api/src/extension-api.d.ts:446"})})]})}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,r)=>{r.d(n,{Z:()=>o,a:()=>i});var t=r(27378);const c={},s=t.createContext(c);function i(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(c):e.components||c:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51320],{60964:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=r(24246),s=r(71670);const i={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L447",children:"packages/extension-api/src/extension-api.d.ts:447"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L446",children:"packages/extension-api/src/extension-api.d.ts:446"})})]})}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/46b3c144.014f86e3.js b/assets/js/46b3c144.0aad8240.js similarity index 76% rename from assets/js/46b3c144.014f86e3.js rename to assets/js/46b3c144.0aad8240.js index 8b2a5a8e0c5..d2a707f72da 100644 --- a/assets/js/46b3c144.014f86e3.js +++ b/assets/js/46b3c144.0aad8240.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1868],{69884:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>i,toc:()=>d});var t=o(24246),s=o(71670);const r={},c="Interface: PodCreatePortOptions",i={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L369",children:"packages/extension-api/src/extension-api.d.ts:369"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L368",children:"packages/extension-api/src/extension-api.d.ts:368"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})})]})}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:()=>i,a:()=>c});var t=o(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 i(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([[1868],{69884:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>r,metadata:()=>c,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L369",children:"packages/extension-api/src/extension-api.d.ts:369"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L368",children:"packages/extension-api/src/extension-api.d.ts:368"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L370",children:"packages/extension-api/src/extension-api.d.ts:370"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L372",children:"packages/extension-api/src/extension-api.d.ts:372"})})]})}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.32502b7d.js b/assets/js/494e8e75.71219572.js similarity index 97% rename from assets/js/494e8e75.32502b7d.js rename to assets/js/494e8e75.71219572.js index ea5c14f2f07..7f7fad2c575 100644 --- a/assets/js/494e8e75.32502b7d.js +++ b/assets/js/494e8e75.71219572.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49076],{8812:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})})]})}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],{8812:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L640",children:"packages/extension-api/src/extension-api.d.ts:640"})})]})}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.67887510.js b/assets/js/49bee2be.3301b071.js similarity index 80% rename from assets/js/49bee2be.67887510.js rename to assets/js/49bee2be.3301b071.js index 288a740fa5c..480a1d6f8e2 100644 --- a/assets/js/49bee2be.67887510.js +++ b/assets/js/49bee2be.3301b071.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80448],{88557:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var i=t(24246),o=t(71670);const a={},s="Function: navigateToContainers()",c={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"}},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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4262",children:"packages/extension-api/src/extension-api.d.ts:4262"})})]})}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:()=>c,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 c(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],{88557:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4262",children:"packages/extension-api/src/extension-api.d.ts:4262"})})]})}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.820f74e1.js b/assets/js/49d9416a.855fb066.js similarity index 98% rename from assets/js/49d9416a.820f74e1.js rename to assets/js/49d9416a.855fb066.js index 4a8d875787c..a27cbc37b10 100644 --- a/assets/js/49d9416a.820f74e1.js +++ b/assets/js/49d9416a.855fb066.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11077],{31978:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3306",children:"packages/extension-api/src/extension-api.d.ts:3306"})})]})}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],{31978:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3306",children:"packages/extension-api/src/extension-api.d.ts:3306"})})]})}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 diff --git a/assets/js/4c217c25.b0b10e89.js b/assets/js/4c217c25.b168f627.js similarity index 79% rename from assets/js/4c217c25.b0b10e89.js rename to assets/js/4c217c25.b168f627.js index 8535c8f2b30..bd9342bd598 100644 --- a/assets/js/4c217c25.b0b10e89.js +++ b/assets/js/4c217c25.b168f627.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{23697:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3277",children:"packages/extension-api/src/extension-api.d.ts:3277"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81900],{23697:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3277",children:"packages/extension-api/src/extension-api.d.ts:3277"})})]})}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 diff --git a/assets/js/4c5becac.e227636b.js b/assets/js/4c5becac.15be30b2.js similarity index 88% rename from assets/js/4c5becac.e227636b.js rename to assets/js/4c5becac.15be30b2.js index 12176589720..f36a83bd0a8 100644 --- a/assets/js/4c5becac.e227636b.js +++ b/assets/js/4c5becac.15be30b2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{65340:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[74961],{65340:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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 diff --git a/assets/js/4f425ff4.c16524b7.js b/assets/js/4f425ff4.f75e69ed.js similarity index 98% rename from assets/js/4f425ff4.c16524b7.js rename to assets/js/4f425ff4.f75e69ed.js index a77371fb0c4..6382f4afc7f 100644 --- a/assets/js/4f425ff4.c16524b7.js +++ b/assets/js/4f425ff4.f75e69ed.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89799],{45174:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L660",children:"packages/extension-api/src/extension-api.d.ts:660"})})]})}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],{45174:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L660",children:"packages/extension-api/src/extension-api.d.ts:660"})})]})}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.2e8961e4.js b/assets/js/4f9e8711.6f5ade5a.js similarity index 90% rename from assets/js/4f9e8711.2e8961e4.js rename to assets/js/4f9e8711.6f5ade5a.js index fce7b555506..e604908869a 100644 --- a/assets/js/4f9e8711.2e8961e4.js +++ b/assets/js/4f9e8711.6f5ade5a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27177],{23912:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}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],{23912:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}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.4640cb9e.js b/assets/js/5046ea8f.121e3d22.js similarity index 86% rename from assets/js/5046ea8f.4640cb9e.js rename to assets/js/5046ea8f.121e3d22.js index 0c985883a19..6bd082d5a45 100644 --- a/assets/js/5046ea8f.4640cb9e.js +++ b/assets/js/5046ea8f.121e3d22.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{55434:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L742",children:"packages/extension-api/src/extension-api.d.ts:742"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75167],{55434:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L742",children:"packages/extension-api/src/extension-api.d.ts:742"})})]})}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 diff --git a/assets/js/54d805e4.1169dd14.js b/assets/js/54d805e4.88ab260f.js similarity index 73% rename from assets/js/54d805e4.1169dd14.js rename to assets/js/54d805e4.88ab260f.js index 8b7190a557a..bd0cb716770 100644 --- a/assets/js/54d805e4.1169dd14.js +++ b/assets/js/54d805e4.88ab260f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33356],{63845:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>l});var i=s(24246),c=s(71670);const o={},r="Interface: VolumeListInfo",t={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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3232",children:"packages/extension-api/src/extension-api.d.ts:3232"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3233",children:"packages/extension-api/src/extension-api.d.ts:3233"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3234",children:"packages/extension-api/src/extension-api.d.ts:3234"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3235",children:"packages/extension-api/src/extension-api.d.ts:3235"})})]})}function u(e={}){const{wrapper:n}={...(0,c.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:()=>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([[33356],{63845:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3232",children:"packages/extension-api/src/extension-api.d.ts:3232"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3233",children:"packages/extension-api/src/extension-api.d.ts:3233"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3234",children:"packages/extension-api/src/extension-api.d.ts:3234"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3235",children:"packages/extension-api/src/extension-api.d.ts:3235"})})]})}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 diff --git a/assets/js/57a8015d.42a99444.js b/assets/js/57a8015d.487ba68e.js similarity index 98% rename from assets/js/57a8015d.42a99444.js rename to assets/js/57a8015d.487ba68e.js index 509330866a5..6cc4b75314a 100644 --- a/assets/js/57a8015d.42a99444.js +++ b/assets/js/57a8015d.487ba68e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27268],{85996:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4296",children:"packages/extension-api/src/extension-api.d.ts:4296"})})]})}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],{85996:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4296",children:"packages/extension-api/src/extension-api.d.ts:4296"})})]})}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.99dac85f.js b/assets/js/57dba496.ab570216.js similarity index 82% rename from assets/js/57dba496.99dac85f.js rename to assets/js/57dba496.ab570216.js index 314dd8de335..b9382891a37 100644 --- a/assets/js/57dba496.99dac85f.js +++ b/assets/js/57dba496.ab570216.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{59278:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=s(24246),c=s(71670);const i={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2504",children:"packages/extension-api/src/extension-api.d.ts:2504"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2505",children:"packages/extension-api/src/extension-api.d.ts:2505"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2500",children:"packages/extension-api/src/extension-api.d.ts:2500"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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 c={},i=r.createContext(c);function t(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(c):e.components||c:t(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5886],{59278:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2504",children:"packages/extension-api/src/extension-api.d.ts:2504"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2505",children:"packages/extension-api/src/extension-api.d.ts:2505"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2497",children:"packages/extension-api/src/extension-api.d.ts:2497"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2499",children:"packages/extension-api/src/extension-api.d.ts:2499"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2500",children:"packages/extension-api/src/extension-api.d.ts:2500"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2498",children:"packages/extension-api/src/extension-api.d.ts:2498"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2496",children:"packages/extension-api/src/extension-api.d.ts:2496"})})]})}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/57e01cd5.81ee1d62.js b/assets/js/57e01cd5.7308a2c1.js similarity index 90% rename from assets/js/57e01cd5.81ee1d62.js rename to assets/js/57e01cd5.7308a2c1.js index 6f88d4a3ecb..71bc72e5218 100644 --- a/assets/js/57e01cd5.81ee1d62.js +++ b/assets/js/57e01cd5.7308a2c1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43546],{39734:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>l});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"}},c={},l=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1304",children:"packages/extension-api/src/extension-api.d.ts:1304"})})]})}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],{39734:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1304",children:"packages/extension-api/src/extension-api.d.ts:1304"})})]})}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.bdd34cd6.js b/assets/js/5a7aef43.0a04170d.js similarity index 94% rename from assets/js/5a7aef43.bdd34cd6.js rename to assets/js/5a7aef43.0a04170d.js index 45edb6cac71..339da2250c1 100644 --- a/assets/js/5a7aef43.bdd34cd6.js +++ b/assets/js/5a7aef43.0a04170d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59081],{68341:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4273",children:"packages/extension-api/src/extension-api.d.ts:4273"})})]})}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],{68341:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4273",children:"packages/extension-api/src/extension-api.d.ts:4273"})})]})}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.823f66a7.js b/assets/js/5a9a7a02.67d9e358.js similarity index 85% rename from assets/js/5a9a7a02.823f66a7.js rename to assets/js/5a9a7a02.67d9e358.js index 69ba9dc2d46..addd22865c5 100644 --- a/assets/js/5a9a7a02.823f66a7.js +++ b/assets/js/5a9a7a02.67d9e358.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{27807:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3491",children:"packages/extension-api/src/extension-api.d.ts:3491"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89472],{27807:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3491",children:"packages/extension-api/src/extension-api.d.ts:3491"})})]})}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/5b10a003.219256f3.js b/assets/js/5b10a003.f194a373.js similarity index 83% rename from assets/js/5b10a003.219256f3.js rename to assets/js/5b10a003.f194a373.js index 6855591d371..1baf4c78802 100644 --- a/assets/js/5b10a003.219256f3.js +++ b/assets/js/5b10a003.f194a373.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{78997:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>n,metadata:()=>o,toc:()=>d});var r=s(24246),c=s(71670);const n={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2895",children:"packages/extension-api/src/extension-api.d.ts:2895"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2892",children:"packages/extension-api/src/extension-api.d.ts:2892"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2890",children:"packages/extension-api/src/extension-api.d.ts:2890"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2893",children:"packages/extension-api/src/extension-api.d.ts:2893"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2894",children:"packages/extension-api/src/extension-api.d.ts:2894"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2897",children:"packages/extension-api/src/extension-api.d.ts:2897"})})]})}function h(e={}){const{wrapper:i}={...(0,c.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 c={},n=r.createContext(c);function t(e){const i=r.useContext(n);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(c):e.components||c:t(e.components),r.createElement(n.Provider,{value:i},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28437],{78997:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var r=s(24246),n=s(71670);const t={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2895",children:"packages/extension-api/src/extension-api.d.ts:2895"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2892",children:"packages/extension-api/src/extension-api.d.ts:2892"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2890",children:"packages/extension-api/src/extension-api.d.ts:2890"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2893",children:"packages/extension-api/src/extension-api.d.ts:2893"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2891",children:"packages/extension-api/src/extension-api.d.ts:2891"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2896",children:"packages/extension-api/src/extension-api.d.ts:2896"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2894",children:"packages/extension-api/src/extension-api.d.ts:2894"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2897",children:"packages/extension-api/src/extension-api.d.ts:2897"})})]})}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:()=>c});var r=s(27378);const n={},t=r.createContext(n);function c(e){const i=r.useContext(t);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:c(e.components),r.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b7d9ef2.aca99384.js b/assets/js/5b7d9ef2.082614b5.js similarity index 94% rename from assets/js/5b7d9ef2.aca99384.js rename to assets/js/5b7d9ef2.082614b5.js index 8efbe67276f..a51a71790a9 100644 --- a/assets/js/5b7d9ef2.aca99384.js +++ b/assets/js/5b7d9ef2.082614b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86112],{65941:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1945",children:"packages/extension-api/src/extension-api.d.ts:1945"})})]})}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],{65941:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1945",children:"packages/extension-api/src/extension-api.d.ts:1945"})})]})}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.433db3c2.js b/assets/js/5bc09a53.f14ade3b.js similarity index 89% rename from assets/js/5bc09a53.433db3c2.js rename to assets/js/5bc09a53.f14ade3b.js index 9a55b90aba5..a78dbd1a186 100644 --- a/assets/js/5bc09a53.433db3c2.js +++ b/assets/js/5bc09a53.f14ade3b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[79649],{43844:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var t=s(24246),i=s(71670);const c={},r="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2541",children:"packages/extension-api/src/extension-api.d.ts:2541"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2569",children:"packages/extension-api/src/extension-api.d.ts:2569"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2560",children:"packages/extension-api/src/extension-api.d.ts:2560"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2532",children:"packages/extension-api/src/extension-api.d.ts:2532"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})})]})}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:()=>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([[79649],{43844:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2541",children:"packages/extension-api/src/extension-api.d.ts:2541"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2569",children:"packages/extension-api/src/extension-api.d.ts:2569"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2560",children:"packages/extension-api/src/extension-api.d.ts:2560"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2532",children:"packages/extension-api/src/extension-api.d.ts:2532"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2550",children:"packages/extension-api/src/extension-api.d.ts:2550"})})]})}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 diff --git a/assets/js/5c0f0993.04eb164b.js b/assets/js/5c0f0993.71388fc3.js similarity index 86% rename from assets/js/5c0f0993.04eb164b.js rename to assets/js/5c0f0993.71388fc3.js index a224edc7752..5d1a4230801 100644 --- a/assets/js/5c0f0993.04eb164b.js +++ b/assets/js/5c0f0993.71388fc3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5674],{79003:(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: TelemetrySender",d={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4054",children:"packages/extension-api/src/extension-api.d.ts:4054"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4048",children:"packages/extension-api/src/extension-api.d.ts:4048"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})})]})}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([[5674],{79003:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4054",children:"packages/extension-api/src/extension-api.d.ts:4054"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4048",children:"packages/extension-api/src/extension-api.d.ts:4048"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4039",children:"packages/extension-api/src/extension-api.d.ts:4039"})})]})}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.0b7347bf.js b/assets/js/5db8318c.23332543.js similarity index 84% rename from assets/js/5db8318c.0b7347bf.js rename to assets/js/5db8318c.23332543.js index 9092f0d6ba2..38f219c108c 100644 --- a/assets/js/5db8318c.0b7347bf.js +++ b/assets/js/5db8318c.23332543.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{58718:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>r,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),c=s(71670);const a={},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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})})]})}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:()=>r});var t=s(27378);const c={},a=t.createContext(c);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(c):e.components||c:r(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58792],{58718:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var t=s(24246),r=s(71670);const a={},c="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,r.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L606",children:"packages/extension-api/src/extension-api.d.ts:606"})})]})}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:()=>o,a:()=>c});var t=s(27378);const r={},a=t.createContext(r);function c(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(r):e.components||r:c(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5e30269e.e1aecbd8.js b/assets/js/5e30269e.f8eec418.js similarity index 97% rename from assets/js/5e30269e.e1aecbd8.js rename to assets/js/5e30269e.f8eec418.js index 9651536f2d0..55f211d94ce 100644 --- a/assets/js/5e30269e.e1aecbd8.js +++ b/assets/js/5e30269e.f8eec418.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27135],{81619:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L278",children:"packages/extension-api/src/extension-api.d.ts:278"})})]})}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],{81619:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L278",children:"packages/extension-api/src/extension-api.d.ts:278"})})]})}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.be1b7d05.js b/assets/js/5e486140.be1b7d05.js new file mode 100644 index 00000000000..cb255c7b8ad --- /dev/null +++ b/assets/js/5e486140.be1b7d05.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{6974:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3500",children:"packages/extension-api/src/extension-api.d.ts:3500"})})]})}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/5e486140.fdbd4446.js b/assets/js/5e486140.fdbd4446.js deleted file mode 100644 index b491dbe751c..00000000000 --- a/assets/js/5e486140.fdbd4446.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26557],{6974:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3500",children:"packages/extension-api/src/extension-api.d.ts:3500"})})]})}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/5e8fbcdf.efaaf4d0.js b/assets/js/5e8fbcdf.efaaf4d0.js deleted file mode 100644 index 27993616e53..00000000000 --- a/assets/js/5e8fbcdf.efaaf4d0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28786:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var c=s(24246),i=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={},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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-buildimageoptions",children:"Interface: BuildImageOptions"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"abortcontroller",children:"abortController?"}),"\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:"abortController"}),": ",(0,c.jsx)(n.code,{children:"AbortController"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The abort controller for running the build image operation"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3025",children:"packages/extension-api/src/extension-api.d.ts:3025"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"buildargs",children:"buildargs?"}),"\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:"buildargs"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.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,c.jsx)(n.code,{children:"Dockerfile"})," RUN instruction, or for variable\nexpansion in other ",(0,c.jsx)(n.code,{children:"Dockerfilev"})," instructions. This is not meant for passing secret values.\nFor example, the build arg ",(0,c.jsx)(n.code,{children:"FOO=bar"})," would become ",(0,c.jsx)(n.code,{children:'{"FOO":"bar"}'})," in JSON. This would result in the query\nparameter ",(0,c.jsx)(n.code,{children:'buildargs={"FOO":"bar"}'}),". Note that ",(0,c.jsx)(n.code,{children:'{"FOO":"bar"}'})," should be URI component encoded."]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3109",children:"packages/extension-api/src/extension-api.d.ts:3109"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cachefrom",children:"cachefrom?"}),"\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:"cachefrom"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"JSON array of images used for build cache resolution."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3051",children:"packages/extension-api/src/extension-api.d.ts:3051"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"containerfile",children:"containerFile?"}),"\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:"containerFile"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Specifies a Containerfile which contains instructions for building the image"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3005",children:"packages/extension-api/src/extension-api.d.ts:3005"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpuperiod",children:"cpuperiod?"}),"\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:"cpuperiod"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The length of a CPU period in microseconds."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3095",children:"packages/extension-api/src/extension-api.d.ts:3095"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpuquota",children:"cpuquota?"}),"\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:"cpuquota"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Microseconds of CPU time that the container can get in a CPU period."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3100",children:"packages/extension-api/src/extension-api.d.ts:3100"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpusetcpus",children:"cpusetcpus?"}),"\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:"cpusetcpus"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"CPUs in which to allow execution (e.g., 0-3, 0,1)."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpushares",children:"cpushares?"}),"\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:"cpushares"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"CPU shares (relative weight)."}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3085",children:"packages/extension-api/src/extension-api.d.ts:3085"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"extrahosts",children:"extrahosts?"}),"\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:"extrahosts"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Extra hosts to add to /etc/hosts"}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3030",children:"packages/extension-api/src/extension-api.d.ts:3030"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"forcerm",children:"forcerm?"}),"\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:"forcerm"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Default: false"}),"\n",(0,c.jsx)(n.p,{children:"Always remove intermediate containers, even upon failure."}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"labels?"}),"\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:"labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Arbitrary key/value labels to set on the image, as a JSON map of string pairs."}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3124",children:"packages/extension-api/src/extension-api.d.ts:3124"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memory",children:"memory?"}),"\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:"memory"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Set memory limit for build."}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3075",children:"packages/extension-api/src/extension-api.d.ts:3075"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memswap",children:"memswap?"}),"\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:"memswap"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Total memory (memory + swap). Set as -1 to disable swap."}),"\n",(0,c.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"networkmode",children:"networkmode?"}),"\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:"networkmode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Sets the networking mode for the run commands during build. Supported standard values are: ",(0,c.jsx)(n.code,{children:"bridge"}),",\n",(0,c.jsx)(n.code,{children:"host"}),", ",(0,c.jsx)(n.code,{children:"none"}),", and ",(0,c.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,c.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"nocache",children:"nocache?"}),"\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:"nocache"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Default: false"}),"\n",(0,c.jsx)(n.p,{children:"Do not use the cache when building the image."}),"\n",(0,c.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3152",children:"packages/extension-api/src/extension-api.d.ts:3152"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"outputs",children:"outputs?"}),"\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:"outputs"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:'Default: ""'}),"\n",(0,c.jsx)(n.p,{children:"BuildKit output configuration"}),"\n",(0,c.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3145",children:"packages/extension-api/src/extension-api.d.ts:3145"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"platform",children:"platform?"}),"\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:"platform"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.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,c.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3015",children:"packages/extension-api/src/extension-api.d.ts:3015"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"provider",children:"provider?"}),"\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:"provider"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnection",children:(0,c.jsx)(n.code,{children:"ContainerProviderConnection"})})]}),"\n"]}),"\n",(0,c.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,c.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3020",children:"packages/extension-api/src/extension-api.d.ts:3020"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"pull",children:"pull?"}),"\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:"pull"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Attempt to pull the image even if an older image exists locally."}),"\n",(0,c.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3056",children:"packages/extension-api/src/extension-api.d.ts:3056"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"q",children:"q?"}),"\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:"q"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Default: false"}),"\n",(0,c.jsx)(n.p,{children:"Suppress verbose build output."}),"\n",(0,c.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3046",children:"packages/extension-api/src/extension-api.d.ts:3046"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"remote",children:"remote?"}),"\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:"remote"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.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,c.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3039",children:"packages/extension-api/src/extension-api.d.ts:3039"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"rm",children:"rm?"}),"\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:"rm"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Default: true"}),"\n",(0,c.jsx)(n.p,{children:"Remove intermediate containers after a successful build."}),"\n",(0,c.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3063",children:"packages/extension-api/src/extension-api.d.ts:3063"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"shmsize",children:"shmsize?"}),"\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:"shmsize"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Size of ",(0,c.jsx)(n.code,{children:"/dev/shm"})," in bytes. The size must be greater than 0. If omitted the system uses 64MB."]}),"\n",(0,c.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3114",children:"packages/extension-api/src/extension-api.d.ts:3114"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"squash",children:"squash?"}),"\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:"squash"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Squash the resulting images layers into a single layer."}),"\n",(0,c.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3119",children:"packages/extension-api/src/extension-api.d.ts:3119"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"tag",children:"tag?"}),"\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:"tag"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Specifies the name which is assigned to the resulting image if the build process completes successfully"}),"\n",(0,c.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3010",children:"packages/extension-api/src/extension-api.d.ts:3010"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"target",children:"target?"}),"\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:"target"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:'Default: ""'}),"\n",(0,c.jsx)(n.p,{children:"Target build stage"}),"\n",(0,c.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3138",children:"packages/extension-api/src/extension-api.d.ts:3138"})})]})}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:()=>t,a:()=>o});var c=s(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 t(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/5e8fbcdf.fe407e5d.js b/assets/js/5e8fbcdf.fe407e5d.js new file mode 100644 index 00000000000..d471e189333 --- /dev/null +++ b/assets/js/5e8fbcdf.fe407e5d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5417],{28786:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var i=s(24246),r=s(71670);const o={},c="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={},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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3025",children:"packages/extension-api/src/extension-api.d.ts:3025"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3109",children:"packages/extension-api/src/extension-api.d.ts:3109"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3095",children:"packages/extension-api/src/extension-api.d.ts:3095"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3100",children:"packages/extension-api/src/extension-api.d.ts:3100"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3090",children:"packages/extension-api/src/extension-api.d.ts:3090"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3085",children:"packages/extension-api/src/extension-api.d.ts:3085"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3030",children:"packages/extension-api/src/extension-api.d.ts:3030"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3070",children:"packages/extension-api/src/extension-api.d.ts:3070"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3124",children:"packages/extension-api/src/extension-api.d.ts:3124"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3075",children:"packages/extension-api/src/extension-api.d.ts:3075"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3080",children:"packages/extension-api/src/extension-api.d.ts:3080"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3131",children:"packages/extension-api/src/extension-api.d.ts:3131"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3056",children:"packages/extension-api/src/extension-api.d.ts:3056"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3046",children:"packages/extension-api/src/extension-api.d.ts:3046"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3063",children:"packages/extension-api/src/extension-api.d.ts:3063"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3114",children:"packages/extension-api/src/extension-api.d.ts:3114"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3119",children:"packages/extension-api/src/extension-api.d.ts:3119"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3138",children:"packages/extension-api/src/extension-api.d.ts:3138"})})]})}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:()=>c});var i=s(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 d(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/604e05e4.a85ddd28.js b/assets/js/604e05e4.a85ddd28.js deleted file mode 100644 index 74afc35acd1..00000000000 --- a/assets/js/604e05e4.a85ddd28.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{98771:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-networkinfo",children:"Interface: NetworkInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"aliases",children:"Aliases?"}),"\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:"Aliases"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"endpointid",children:"EndpointID"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"EndpointID"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"gateway",children:"Gateway"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Gateway"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"globalipv6address",children:"GlobalIPv6Address"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"GlobalIPv6Address"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"globalipv6prefixlen",children:"GlobalIPv6PrefixLen"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"GlobalIPv6PrefixLen"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipamconfig",children:"IPAMConfig?"}),"\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:"IPAMConfig"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2139",children:"packages/extension-api/src/extension-api.d.ts:2139"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipaddress",children:"IPAddress"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"IPAddress"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipprefixlen",children:"IPPrefixLen"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"IPPrefixLen"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipv6gateway",children:"IPv6Gateway"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"IPv6Gateway"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2140",children:"packages/extension-api/src/extension-api.d.ts:2140"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"macaddress",children:"MacAddress"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"MacAddress"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"networkid",children:"NetworkID"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"NetworkID"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})})]})}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:()=>t,a:()=>o});var c=s(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 t(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/604e05e4.bda07093.js b/assets/js/604e05e4.bda07093.js new file mode 100644 index 00000000000..951f7b0b31c --- /dev/null +++ b/assets/js/604e05e4.bda07093.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62871],{98771:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2141",children:"packages/extension-api/src/extension-api.d.ts:2141"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2143",children:"packages/extension-api/src/extension-api.d.ts:2143"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2144",children:"packages/extension-api/src/extension-api.d.ts:2144"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2148",children:"packages/extension-api/src/extension-api.d.ts:2148"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2149",children:"packages/extension-api/src/extension-api.d.ts:2149"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2145",children:"packages/extension-api/src/extension-api.d.ts:2145"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2146",children:"packages/extension-api/src/extension-api.d.ts:2146"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2147",children:"packages/extension-api/src/extension-api.d.ts:2147"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2150",children:"packages/extension-api/src/extension-api.d.ts:2150"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2142",children:"packages/extension-api/src/extension-api.d.ts:2142"})})]})}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 diff --git a/assets/js/60c82955.678d314c.js b/assets/js/60c82955.86d7465b.js similarity index 83% rename from assets/js/60c82955.678d314c.js rename to assets/js/60c82955.86d7465b.js index bc926361641..d3f96461a32 100644 --- a/assets/js/60c82955.678d314c.js +++ b/assets/js/60c82955.86d7465b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{92095:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>t});var i=n(24246),c=n(71670);const r={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4156",children:"packages/extension-api/src/extension-api.d.ts:4156"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4160",children:"packages/extension-api/src/extension-api.d.ts:4160"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4154",children:"packages/extension-api/src/extension-api.d.ts:4154"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4159",children:"packages/extension-api/src/extension-api.d.ts:4159"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4157",children:"packages/extension-api/src/extension-api.d.ts:4157"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4166",children:"packages/extension-api/src/extension-api.d.ts:4166"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4158",children:"packages/extension-api/src/extension-api.d.ts:4158"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4169",children:"packages/extension-api/src/extension-api.d.ts:4169"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4165",children:"packages/extension-api/src/extension-api.d.ts:4165"})})]})}function h(e={}){const{wrapper:s}={...(0,c.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 c={},r=i.createContext(c);function d(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(c):e.components||c:d(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48926],{92095:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>t});var i=n(24246),r=n(71670);const d={},o="Interface: CliTool",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4156",children:"packages/extension-api/src/extension-api.d.ts:4156"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4160",children:"packages/extension-api/src/extension-api.d.ts:4160"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4154",children:"packages/extension-api/src/extension-api.d.ts:4154"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4159",children:"packages/extension-api/src/extension-api.d.ts:4159"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4157",children:"packages/extension-api/src/extension-api.d.ts:4157"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4155",children:"packages/extension-api/src/extension-api.d.ts:4155"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4166",children:"packages/extension-api/src/extension-api.d.ts:4166"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4158",children:"packages/extension-api/src/extension-api.d.ts:4158"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4169",children:"packages/extension-api/src/extension-api.d.ts:4169"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4165",children:"packages/extension-api/src/extension-api.d.ts:4165"})})]})}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:()=>c,a:()=>o});var i=n(27378);const r={},d=i.createContext(r);function o(e){const s=i.useContext(d);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(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/610f2c47.e9b8ad31.js b/assets/js/610f2c47.d24e572b.js similarity index 93% rename from assets/js/610f2c47.e9b8ad31.js rename to assets/js/610f2c47.d24e572b.js index 5979200020a..3b02603fa9b 100644 --- a/assets/js/610f2c47.e9b8ad31.js +++ b/assets/js/610f2c47.d24e572b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[23937],{19355:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1818",children:"packages/extension-api/src/extension-api.d.ts:1818"})})]})}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],{19355:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1818",children:"packages/extension-api/src/extension-api.d.ts:1818"})})]})}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.3eafeeb5.js b/assets/js/612345e6.15511ec7.js similarity index 95% rename from assets/js/612345e6.3eafeeb5.js rename to assets/js/612345e6.15511ec7.js index 3ad4f676771..c7f7711b2df 100644 --- a/assets/js/612345e6.3eafeeb5.js +++ b/assets/js/612345e6.15511ec7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[47389],{8846:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4288",children:"packages/extension-api/src/extension-api.d.ts:4288"})})]})}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],{8846:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4288",children:"packages/extension-api/src/extension-api.d.ts:4288"})})]})}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.1204aeff.js b/assets/js/62e21724.1204aeff.js deleted file mode 100644 index 6e2cec23df3..00000000000 --- a/assets/js/62e21724.1204aeff.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{38536:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var c=t(24246),i=t(71670);const o={},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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-quickinputbutton",children:"Interface: QuickInputButton"}),"\n",(0,c.jsx)(n.p,{children:"Button for an action in a QuickPick or InputBox."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"iconpath",children:"iconPath"}),"\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:"iconPath"}),": ",(0,c.jsx)(n.a,{href:"/api/classes/Uri",children:(0,c.jsx)(n.code,{children:"Uri"})})," | ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Icon for the button."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1041",children:"packages/extension-api/src/extension-api.d.ts:1041"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"tooltip",children:"tooltip?"}),"\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.code,{children:"readonly"})," ",(0,c.jsx)(n.strong,{children:"tooltip"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"An optional tooltip."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1046",children:"packages/extension-api/src/extension-api.d.ts:1046"})})]})}function p(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(u,{...e})}):u(e)}},71670:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>r});var c=t(27378);const i={},o=c.createContext(i);function r(e){const n=c.useContext(o);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:r(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/62e21724.2818998b.js b/assets/js/62e21724.2818998b.js new file mode 100644 index 00000000000..1e7eb45b088 --- /dev/null +++ b/assets/js/62e21724.2818998b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33067],{38536:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1041",children:"packages/extension-api/src/extension-api.d.ts:1041"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1046",children:"packages/extension-api/src/extension-api.d.ts:1046"})})]})}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 diff --git a/assets/js/640277b9.311ab57b.js b/assets/js/640277b9.4d53f2a3.js similarity index 95% rename from assets/js/640277b9.311ab57b.js rename to assets/js/640277b9.4d53f2a3.js index 7251dcd5121..b8c92e0135b 100644 --- a/assets/js/640277b9.311ab57b.js +++ b/assets/js/640277b9.4d53f2a3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48901],{18630:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1911",children:"packages/extension-api/src/extension-api.d.ts:1911"})})]})}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],{18630:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1911",children:"packages/extension-api/src/extension-api.d.ts:1911"})})]})}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.4a0f5b04.js b/assets/js/64134c03.ae7b7f88.js similarity index 80% rename from assets/js/64134c03.4a0f5b04.js rename to assets/js/64134c03.ae7b7f88.js index 2ae44bcbb62..aca38763ae1 100644 --- a/assets/js/64134c03.4a0f5b04.js +++ b/assets/js/64134c03.ae7b7f88.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{28:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var s=t(24246),o=t(71670);const c={},i="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L693",children:"packages/extension-api/src/extension-api.d.ts:693"})})]})}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:()=>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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71796],{28:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L693",children:"packages/extension-api/src/extension-api.d.ts:693"})})]})}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 diff --git a/assets/js/6477cdc2.7fb00b71.js b/assets/js/6477cdc2.9f45292a.js similarity index 87% rename from assets/js/6477cdc2.7fb00b71.js rename to assets/js/6477cdc2.9f45292a.js index de0b1cde9b7..6e33a8dee92 100644 --- a/assets/js/6477cdc2.7fb00b71.js +++ b/assets/js/6477cdc2.9f45292a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{52321:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>l});var t=r(24246),s=r(71670);const c={},o="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3832",children:"packages/extension-api/src/extension-api.d.ts:3832"})})]})}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:()=>o});var t=r(27378);const s={},c=t.createContext(s);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(s):e.components||s:o(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16696],{52321:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3832",children:"packages/extension-api/src/extension-api.d.ts:3832"})})]})}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.3469177e.js b/assets/js/6494b798.c4094b65.js similarity index 84% rename from assets/js/6494b798.3469177e.js rename to assets/js/6494b798.c4094b65.js index ef688bc8322..8aa6074a997 100644 --- a/assets/js/6494b798.3469177e.js +++ b/assets/js/6494b798.c4094b65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{92650:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3795",children:"packages/extension-api/src/extension-api.d.ts:3795"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41619],{92650:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3795",children:"packages/extension-api/src/extension-api.d.ts:3795"})})]})}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 diff --git a/assets/js/64bd32f2.1f8c08ef.js b/assets/js/64bd32f2.1f8c08ef.js deleted file mode 100644 index 4de2d742879..00000000000 --- a/assets/js/64bd32f2.1f8c08ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{11197:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3506",children:"packages/extension-api/src/extension-api.d.ts:3506"})})]})}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/64bd32f2.2dc23425.js b/assets/js/64bd32f2.2dc23425.js new file mode 100644 index 00000000000..c6b4eefe6b8 --- /dev/null +++ b/assets/js/64bd32f2.2dc23425.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76192],{11197:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3506",children:"packages/extension-api/src/extension-api.d.ts:3506"})})]})}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/67386898.98565c6a.js b/assets/js/67386898.45bbd73f.js similarity index 91% rename from assets/js/67386898.98565c6a.js rename to assets/js/67386898.45bbd73f.js index 979bb92cdd6..33294c00f2c 100644 --- a/assets/js/67386898.98565c6a.js +++ b/assets/js/67386898.45bbd73f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20406],{39607:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3239",children:"packages/extension-api/src/extension-api.d.ts:3239"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3241",children:"packages/extension-api/src/extension-api.d.ts:3241"})})]})}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],{39607:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3239",children:"packages/extension-api/src/extension-api.d.ts:3239"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3241",children:"packages/extension-api/src/extension-api.d.ts:3241"})})]})}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.bfdf197b.js b/assets/js/6763d4e0.5d4eac38.js similarity index 82% rename from assets/js/6763d4e0.bfdf197b.js rename to assets/js/6763d4e0.5d4eac38.js index 07b8d078465..8cb6613b6d6 100644 --- a/assets/js/6763d4e0.bfdf197b.js +++ b/assets/js/6763d4e0.5d4eac38.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{23558:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3461",children:"packages/extension-api/src/extension-api.d.ts:3461"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84513],{23558:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3461",children:"packages/extension-api/src/extension-api.d.ts:3461"})})]})}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 diff --git a/assets/js/6774f806.74d51643.js b/assets/js/6774f806.3d255472.js similarity index 81% rename from assets/js/6774f806.74d51643.js rename to assets/js/6774f806.3d255472.js index 301c11444ac..9b12e3ea4f4 100644 --- a/assets/js/6774f806.74d51643.js +++ b/assets/js/6774f806.3d255472.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{81117:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3438",children:"packages/extension-api/src/extension-api.d.ts:3438"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35572],{81117:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>l});var t=i(24246),o=i(71670);const r={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3438",children:"packages/extension-api/src/extension-api.d.ts:3438"})})]})}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:()=>c});var t=i(27378);const o={},r=t.createContext(o);function c(e){const n=t.useContext(r);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(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67eba1be.f64fd34f.js b/assets/js/67eba1be.8098a6a3.js similarity index 75% rename from assets/js/67eba1be.f64fd34f.js rename to assets/js/67eba1be.8098a6a3.js index f412aa91185..7b380511ec4 100644 --- a/assets/js/67eba1be.f64fd34f.js +++ b/assets/js/67eba1be.8098a6a3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{70166:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>i,metadata:()=>r,toc:()=>d});var s=t(24246),c=t(71670);const i={},o="Interface: Command",r={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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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,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:()=>o});var s=t(27378);const c={},i=s.createContext(c);function o(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(c):e.components||c:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52950],{70166:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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.5b0f67eb.js b/assets/js/67fccd64.5b0f67eb.js new file mode 100644 index 00000000000..9f025c32904 --- /dev/null +++ b/assets/js/67fccd64.5b0f67eb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{33837:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2992",children:"packages/extension-api/src/extension-api.d.ts:2992"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2997",children:"packages/extension-api/src/extension-api.d.ts:2997"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2987",children:"packages/extension-api/src/extension-api.d.ts:2987"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2988",children:"packages/extension-api/src/extension-api.d.ts:2988"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2996",children:"packages/extension-api/src/extension-api.d.ts:2996"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2993",children:"packages/extension-api/src/extension-api.d.ts:2993"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2991",children:"packages/extension-api/src/extension-api.d.ts:2991"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2998",children:"packages/extension-api/src/extension-api.d.ts:2998"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2989",children:"packages/extension-api/src/extension-api.d.ts:2989"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2994",children:"packages/extension-api/src/extension-api.d.ts:2994"})})]})}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/67fccd64.6c2e3bba.js b/assets/js/67fccd64.6c2e3bba.js deleted file mode 100644 index deb0cef387c..00000000000 --- a/assets/js/67fccd64.6c2e3bba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77319],{33837:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>d});var c=n(24246),t=n(71670);const i={},r="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,t.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(s.h1,{id:"interface-containerstatsinfo",children:"Interface: ContainerStatsInfo"}),"\n",(0,c.jsx)(s.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(s.h3,{id:"blkio_stats",children:"blkio_stats?"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"optional"})," ",(0,c.jsx)(s.strong,{children:"blkio_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/BlkioStats",children:(0,c.jsx)(s.code,{children:"BlkioStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2992",children:"packages/extension-api/src/extension-api.d.ts:2992"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"cpu_stats",children:"cpu_stats"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"cpu_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,c.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-1",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2997",children:"packages/extension-api/src/extension-api.d.ts:2997"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"engineId"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-2",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2987",children:"packages/extension-api/src/extension-api.d.ts:2987"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"enginename",children:"engineName"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"engineName"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-3",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2988",children:"packages/extension-api/src/extension-api.d.ts:2988"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"memory_stats",children:"memory_stats"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"memory_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/MemoryStats",children:(0,c.jsx)(s.code,{children:"MemoryStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-4",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2996",children:"packages/extension-api/src/extension-api.d.ts:2996"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"networks",children:"networks"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"networks"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/NetworkStats",children:(0,c.jsx)(s.code,{children:"NetworkStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-5",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2995",children:"packages/extension-api/src/extension-api.d.ts:2995"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"num_procs",children:"num_procs"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"num_procs"}),": ",(0,c.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-6",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2993",children:"packages/extension-api/src/extension-api.d.ts:2993"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"pids_stats",children:"pids_stats?"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"optional"})," ",(0,c.jsx)(s.strong,{children:"pids_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/PidsStats",children:(0,c.jsx)(s.code,{children:"PidsStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2991",children:"packages/extension-api/src/extension-api.d.ts:2991"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"precpu_stats",children:"precpu_stats"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"precpu_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/CPUStats",children:(0,c.jsx)(s.code,{children:"CPUStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2998",children:"packages/extension-api/src/extension-api.d.ts:2998"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"preread",children:"preread"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"preread"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2990",children:"packages/extension-api/src/extension-api.d.ts:2990"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"read",children:"read"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.strong,{children:"read"}),": ",(0,c.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2989",children:"packages/extension-api/src/extension-api.d.ts:2989"})}),"\n",(0,c.jsx)(s.hr,{}),"\n",(0,c.jsx)(s.h3,{id:"storage_stats",children:"storage_stats?"}),"\n",(0,c.jsxs)(s.blockquote,{children:["\n",(0,c.jsxs)(s.p,{children:[(0,c.jsx)(s.code,{children:"optional"})," ",(0,c.jsx)(s.strong,{children:"storage_stats"}),": ",(0,c.jsx)(s.a,{href:"/api/interfaces/StorageStats",children:(0,c.jsx)(s.code,{children:"StorageStats"})})]}),"\n"]}),"\n",(0,c.jsx)(s.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(s.p,{children:(0,c.jsx)(s.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2994",children:"packages/extension-api/src/extension-api.d.ts:2994"})})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,c.jsx)(s,{...e,children:(0,c.jsx)(l,{...e})}):l(e)}},71670:(e,s,n)=>{n.d(s,{Z:()=>a,a:()=>r});var c=n(27378);const t={},i=c.createContext(t);function r(e){const s=c.useContext(i);return c.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:r(e.components),c.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/688ee267.41754d58.js b/assets/js/688ee267.df4e66e0.js similarity index 87% rename from assets/js/688ee267.41754d58.js rename to assets/js/688ee267.df4e66e0.js index dbd351e388e..edb21e7ac97 100644 --- a/assets/js/688ee267.41754d58.js +++ b/assets/js/688ee267.df4e66e0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17708],{61733:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3755",children:"packages/extension-api/src/extension-api.d.ts:3755"})})]})}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],{61733:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChangeSessions()",r={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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3755",children:"packages/extension-api/src/extension-api.d.ts:3755"})})]})}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:()=>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/6a1fe514.298d6263.js b/assets/js/6a1fe514.7bf01240.js similarity index 75% rename from assets/js/6a1fe514.298d6263.js rename to assets/js/6a1fe514.7bf01240.js index a874cd26a36..62f6cf68f52 100644 --- a/assets/js/6a1fe514.298d6263.js +++ b/assets/js/6a1fe514.7bf01240.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{70908:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L705",children:"packages/extension-api/src/extension-api.d.ts:705"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L701",children:"packages/extension-api/src/extension-api.d.ts:701"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L702",children:"packages/extension-api/src/extension-api.d.ts:702"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96017],{70908:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L705",children:"packages/extension-api/src/extension-api.d.ts:705"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L701",children:"packages/extension-api/src/extension-api.d.ts:701"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L702",children:"packages/extension-api/src/extension-api.d.ts:702"})})]})}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 diff --git a/assets/js/6aa0b043.3d0d1f30.js b/assets/js/6aa0b043.d2d3dae7.js similarity index 89% rename from assets/js/6aa0b043.3d0d1f30.js rename to assets/js/6aa0b043.d2d3dae7.js index d973930c66e..292a96831e0 100644 --- a/assets/js/6aa0b043.3d0d1f30.js +++ b/assets/js/6aa0b043.d2d3dae7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84507],{28923:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>d});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"}},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 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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L653",children:"packages/extension-api/src/extension-api.d.ts:653"})})]})}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],{28923:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L654",children:"packages/extension-api/src/extension-api.d.ts:654"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L653",children:"packages/extension-api/src/extension-api.d.ts:653"})})]})}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.8b94ca83.js b/assets/js/6e30ac7b.8b94ca83.js deleted file mode 100644 index fc14a5b2e46..00000000000 --- a/assets/js/6e30ac7b.8b94ca83.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{91803:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});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"}},a={},l=[{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 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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1082",children:"packages/extension-api/src/extension-api.d.ts:1082"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1077",children:"packages/extension-api/src/extension-api.d.ts:1077"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1061",children:"packages/extension-api/src/extension-api.d.ts:1061"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1066",children:"packages/extension-api/src/extension-api.d.ts:1066"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1071",children:"packages/extension-api/src/extension-api.d.ts:1071"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1056",children:"packages/extension-api/src/extension-api.d.ts:1056"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1088",children:"packages/extension-api/src/extension-api.d.ts:1088"})})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(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/6e30ac7b.cd230b6f.js b/assets/js/6e30ac7b.cd230b6f.js new file mode 100644 index 00000000000..21875cd0060 --- /dev/null +++ b/assets/js/6e30ac7b.cd230b6f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57368],{91803:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});var s=i(24246),t=i(71670);const c={},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,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-quickpickoptions",children:"Interface: QuickPickOptions"}),"\n",(0,s.jsx)(n.p,{children:"Options to configure the behavior of the quick pick UI."}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"canpickmany",children:"canPickMany?"}),"\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:"canPickMany"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1082",children:"packages/extension-api/src/extension-api.d.ts:1082"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"ignorefocusout",children:"ignoreFocusOut?"}),"\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:"ignoreFocusOut"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Set to ",(0,s.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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1077",children:"packages/extension-api/src/extension-api.d.ts:1077"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"matchondescription",children:"matchOnDescription?"}),"\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:"matchOnDescription"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional flag to include the description when filtering the picks."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1061",children:"packages/extension-api/src/extension-api.d.ts:1061"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"matchondetail",children:"matchOnDetail?"}),"\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:"matchOnDetail"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional flag to include the detail when filtering the picks."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1066",children:"packages/extension-api/src/extension-api.d.ts:1066"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"placeholder",children:"placeHolder?"}),"\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:"placeHolder"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1071",children:"packages/extension-api/src/extension-api.d.ts:1071"})}),"\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:"An optional string that represents the title of the quick pick."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1056",children:"packages/extension-api/src/extension-api.d.ts:1056"})}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"ondidselectitem",children:"onDidSelectItem()?"}),"\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:"onDidSelectItem"}),"(",(0,s.jsx)(n.code,{children:"item"}),"): ",(0,s.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"An optional function that is invoked whenever an item is selected."}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"item"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/api/interfaces/QuickPickItem",children:(0,s.jsx)(n.code,{children:"QuickPickItem"})})]}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"any"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1088",children:"packages/extension-api/src/extension-api.d.ts:1088"})})]})}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:()=>r,a:()=>o});var s=i(27378);const t={},c=s.createContext(t);function o(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(t):e.components||t:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e92edd9.2bd02d89.js b/assets/js/6e92edd9.d2187474.js similarity index 88% rename from assets/js/6e92edd9.2bd02d89.js rename to assets/js/6e92edd9.d2187474.js index bc1068e428f..f68b7d958f3 100644 --- a/assets/js/6e92edd9.2bd02d89.js +++ b/assets/js/6e92edd9.d2187474.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63652],{26589:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>d,toc:()=>o});var r=s(24246),i=s(71670);const c={},t="Interface: Configuration",d={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L785",children:"packages/extension-api/src/extension-api.d.ts:785"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L794",children:"packages/extension-api/src/extension-api.d.ts:794"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L802",children:"packages/extension-api/src/extension-api.d.ts:802"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L808",children:"packages/extension-api/src/extension-api.d.ts:808"})})]})}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([[63652],{26589:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});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"}},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L785",children:"packages/extension-api/src/extension-api.d.ts:785"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L794",children:"packages/extension-api/src/extension-api.d.ts:794"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L802",children:"packages/extension-api/src/extension-api.d.ts:802"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L808",children:"packages/extension-api/src/extension-api.d.ts:808"})})]})}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 diff --git a/assets/js/6eafe0c7.8955f346.js b/assets/js/6eafe0c7.294e5a73.js similarity index 84% rename from assets/js/6eafe0c7.8955f346.js rename to assets/js/6eafe0c7.294e5a73.js index 2fee7345e96..b13342cb724 100644 --- a/assets/js/6eafe0c7.8955f346.js +++ b/assets/js/6eafe0c7.294e5a73.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[88089],{87532:(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: 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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2591",children:"packages/extension-api/src/extension-api.d.ts:2591"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2646",children:"packages/extension-api/src/extension-api.d.ts:2646"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2636",children:"packages/extension-api/src/extension-api.d.ts:2636"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2601",children:"packages/extension-api/src/extension-api.d.ts:2601"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2606",children:"packages/extension-api/src/extension-api.d.ts:2606"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2626",children:"packages/extension-api/src/extension-api.d.ts:2626"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2631",children:"packages/extension-api/src/extension-api.d.ts:2631"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2611",children:"packages/extension-api/src/extension-api.d.ts:2611"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2616",children:"packages/extension-api/src/extension-api.d.ts:2616"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2621",children:"packages/extension-api/src/extension-api.d.ts:2621"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2589",children:"packages/extension-api/src/extension-api.d.ts:2589"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2596",children:"packages/extension-api/src/extension-api.d.ts:2596"})})]})}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([[88089],{87532:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var i=s(24246),r=s(71670);const d={},o="Interface: EndpointSettings",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2591",children:"packages/extension-api/src/extension-api.d.ts:2591"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2646",children:"packages/extension-api/src/extension-api.d.ts:2646"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2636",children:"packages/extension-api/src/extension-api.d.ts:2636"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2601",children:"packages/extension-api/src/extension-api.d.ts:2601"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2606",children:"packages/extension-api/src/extension-api.d.ts:2606"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2626",children:"packages/extension-api/src/extension-api.d.ts:2626"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2631",children:"packages/extension-api/src/extension-api.d.ts:2631"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2611",children:"packages/extension-api/src/extension-api.d.ts:2611"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2616",children:"packages/extension-api/src/extension-api.d.ts:2616"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2621",children:"packages/extension-api/src/extension-api.d.ts:2621"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2589",children:"packages/extension-api/src/extension-api.d.ts:2589"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2596",children:"packages/extension-api/src/extension-api.d.ts:2596"})})]})}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:()=>c,a:()=>o});var i=s(27378);const r={},d=i.createContext(r);function o(e){const n=i.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/70e3b13c.c04ea0e7.js b/assets/js/70e3b13c.03de006f.js similarity index 95% rename from assets/js/70e3b13c.c04ea0e7.js rename to assets/js/70e3b13c.03de006f.js index 4e7307fe105..72c6cdb667e 100644 --- a/assets/js/70e3b13c.c04ea0e7.js +++ b/assets/js/70e3b13c.03de006f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25817],{2656:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})})]})}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],{2656:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L736",children:"packages/extension-api/src/extension-api.d.ts:736"})})]})}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.51d4a2b0.js b/assets/js/714e70d1.d7bba4ca.js similarity index 78% rename from assets/js/714e70d1.51d4a2b0.js rename to assets/js/714e70d1.d7bba4ca.js index 59bd274f6ff..187e2cbd040 100644 --- a/assets/js/714e70d1.51d4a2b0.js +++ b/assets/js/714e70d1.d7bba4ca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[648],{80071:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L623",children:"packages/extension-api/src/extension-api.d.ts:623"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L624",children:"packages/extension-api/src/extension-api.d.ts:624"})})]})}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],{80071:(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: ProviderEvent",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L622",children:"packages/extension-api/src/extension-api.d.ts:622"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L623",children:"packages/extension-api/src/extension-api.d.ts:623"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L624",children:"packages/extension-api/src/extension-api.d.ts:624"})})]})}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/71748509.bc090dff.js b/assets/js/71748509.1b326873.js similarity index 95% rename from assets/js/71748509.bc090dff.js rename to assets/js/71748509.1b326873.js index 42c3811732f..e48ca7a6e14 100644 --- a/assets/js/71748509.bc090dff.js +++ b/assets/js/71748509.1b326873.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97227],{17001:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})})]})}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],{17001:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L739",children:"packages/extension-api/src/extension-api.d.ts:739"})})]})}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.b8f65384.js b/assets/js/7258860f.b8f65384.js new file mode 100644 index 00000000000..b6669d36979 --- /dev/null +++ b/assets/js/7258860f.b8f65384.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{87064:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3315",children:"packages/extension-api/src/extension-api.d.ts:3315"})})]})}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.ec176b3c.js b/assets/js/7258860f.ec176b3c.js deleted file mode 100644 index 9aace2bcebd..00000000000 --- a/assets/js/7258860f.ec176b3c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92423],{87064:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3315",children:"packages/extension-api/src/extension-api.d.ts:3315"})})]})}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.2b39b615.js b/assets/js/73f18a6f.896d54fc.js similarity index 95% rename from assets/js/73f18a6f.2b39b615.js rename to assets/js/73f18a6f.896d54fc.js index 5b51188c6cf..dcaf0116626 100644 --- a/assets/js/73f18a6f.2b39b615.js +++ b/assets/js/73f18a6f.896d54fc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14499],{46403:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L658",children:"packages/extension-api/src/extension-api.d.ts:658"})})]})}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],{46403:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L658",children:"packages/extension-api/src/extension-api.d.ts:658"})})]})}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.1eae5c2e.js b/assets/js/73f9658e.4739fab4.js similarity index 88% rename from assets/js/73f9658e.1eae5c2e.js rename to assets/js/73f9658e.4739fab4.js index 6a6f2c1784c..113defc3699 100644 --- a/assets/js/73f9658e.1eae5c2e.js +++ b/assets/js/73f9658e.4739fab4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{34683:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=s(24246),t=s(71670);const a={},c="Function: pushImage()",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3424",children:"packages/extension-api/src/extension-api.d.ts:3424"})})]})}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:()=>c});var i=s(27378);const t={},a=i.createContext(t);function c(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:c(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61305],{34683:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3424",children:"packages/extension-api/src/extension-api.d.ts:3424"})})]})}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.f3098bf7.js b/assets/js/74b658de.54f27c8e.js similarity index 78% rename from assets/js/74b658de.f3098bf7.js rename to assets/js/74b658de.54f27c8e.js index 1ea9ffef2e0..fa0d9230ac8 100644 --- a/assets/js/74b658de.f3098bf7.js +++ b/assets/js/74b658de.54f27c8e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{96350:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>i,toc:()=>d});var s=o(24246),r=o(71670);const t={},c="Function: removePod()",i={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3502",children:"packages/extension-api/src/extension-api.d.ts:3502"})})]})}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:()=>i,a:()=>c});var s=o(27378);const r={},t=s.createContext(r);function c(e){const n=s.useContext(t);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(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62283],{96350:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});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"}},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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3502",children:"packages/extension-api/src/extension-api.d.ts:3502"})})]})}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.98891618.js b/assets/js/7500e360.b87905dd.js similarity index 78% rename from assets/js/7500e360.98891618.js rename to assets/js/7500e360.b87905dd.js index 5c7f5d4d5e3..89784ed1e0a 100644 --- a/assets/js/7500e360.98891618.js +++ b/assets/js/7500e360.b87905dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86272],{7809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var o=s(24246),i=s(71670);const t={},c="Function: showSaveDialog()",a={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1836",children:"packages/extension-api/src/extension-api.d.ts:1836"})})]})}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:()=>a,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 a(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([[86272],{7809:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var o=s(24246),i=s(71670);const t={},a="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"}},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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1836",children:"packages/extension-api/src/extension-api.d.ts:1836"})})]})}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:()=>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 r(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 diff --git a/assets/js/7547d3bb.f20311bf.js b/assets/js/7547d3bb.625439bf.js similarity index 97% rename from assets/js/7547d3bb.f20311bf.js rename to assets/js/7547d3bb.625439bf.js index 3438a73324f..8b70d60671c 100644 --- a/assets/js/7547d3bb.f20311bf.js +++ b/assets/js/7547d3bb.625439bf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45835],{99145:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})})]})}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],{99145:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L516",children:"packages/extension-api/src/extension-api.d.ts:516"})})]})}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.6593d5fc.js b/assets/js/786fee93.c6aba5dc.js similarity index 78% rename from assets/js/786fee93.6593d5fc.js rename to assets/js/786fee93.c6aba5dc.js index 829f8079b76..2f66639fa91 100644 --- a/assets/js/786fee93.6593d5fc.js +++ b/assets/js/786fee93.c6aba5dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[7371],{26440:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3803",children:"packages/extension-api/src/extension-api.d.ts:3803"})})]})}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],{26440:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var i=s(24246),t=s(71670);const a={},r="Variable: isLinux",o={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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3803",children:"packages/extension-api/src/extension-api.d.ts:3803"})})]})}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:()=>o,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 o(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.be0558ee.js b/assets/js/79f18c88.676b9825.js similarity index 75% rename from assets/js/79f18c88.be0558ee.js rename to assets/js/79f18c88.676b9825.js index f727eb0e687..dd1e5cc1d2f 100644 --- a/assets/js/79f18c88.be0558ee.js +++ b/assets/js/79f18c88.676b9825.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36006],{66472:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=s(24246),t=s(71670);const i={},c="Interface: ContainerAuthInfo",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2492",children:"packages/extension-api/src/extension-api.d.ts:2492"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2490",children:"packages/extension-api/src/extension-api.d.ts:2490"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})})]})}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:()=>o,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 o(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([[36006],{66472:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2492",children:"packages/extension-api/src/extension-api.d.ts:2492"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2490",children:"packages/extension-api/src/extension-api.d.ts:2490"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2491",children:"packages/extension-api/src/extension-api.d.ts:2491"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2489",children:"packages/extension-api/src/extension-api.d.ts:2489"})})]})}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 diff --git a/assets/js/7aa856d6.ba55a1ba.js b/assets/js/7aa856d6.b9b501ef.js similarity index 93% rename from assets/js/7aa856d6.ba55a1ba.js rename to assets/js/7aa856d6.b9b501ef.js index 1b5e8d73428..94eaf5be29a 100644 --- a/assets/js/7aa856d6.ba55a1ba.js +++ b/assets/js/7aa856d6.b9b501ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[886],{56886:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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],{56886:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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.1207ff8b.js b/assets/js/7bef3f04.6d1a90c8.js similarity index 98% rename from assets/js/7bef3f04.1207ff8b.js rename to assets/js/7bef3f04.6d1a90c8.js index ec76825a17f..3ff412bfcb7 100644 --- a/assets/js/7bef3f04.1207ff8b.js +++ b/assets/js/7bef3f04.6d1a90c8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24498],{7346:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L663",children:"packages/extension-api/src/extension-api.d.ts:663"})})]})}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],{7346:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L663",children:"packages/extension-api/src/extension-api.d.ts:663"})})]})}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.cd6179b5.js b/assets/js/7c7a772e.e6fcd045.js similarity index 85% rename from assets/js/7c7a772e.cd6179b5.js rename to assets/js/7c7a772e.e6fcd045.js index 972d09306f1..39908b24ccd 100644 --- a/assets/js/7c7a772e.cd6179b5.js +++ b/assets/js/7c7a772e.e6fcd045.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{44215:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});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={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1587",children:"packages/extension-api/src/extension-api.d.ts:1587"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1566",children:"packages/extension-api/src/extension-api.d.ts:1566"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1597",children:"packages/extension-api/src/extension-api.d.ts:1597"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1607",children:"packages/extension-api/src/extension-api.d.ts:1607"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1561",children:"packages/extension-api/src/extension-api.d.ts:1561"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1556",children:"packages/extension-api/src/extension-api.d.ts:1556"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1592",children:"packages/extension-api/src/extension-api.d.ts:1592"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1582",children:"packages/extension-api/src/extension-api.d.ts:1582"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1622",children:"packages/extension-api/src/extension-api.d.ts:1622"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1613",children:"packages/extension-api/src/extension-api.d.ts:1613"})})]})}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:()=>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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77060],{44215:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1587",children:"packages/extension-api/src/extension-api.d.ts:1587"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1566",children:"packages/extension-api/src/extension-api.d.ts:1566"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1597",children:"packages/extension-api/src/extension-api.d.ts:1597"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1607",children:"packages/extension-api/src/extension-api.d.ts:1607"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1561",children:"packages/extension-api/src/extension-api.d.ts:1561"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1556",children:"packages/extension-api/src/extension-api.d.ts:1556"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1592",children:"packages/extension-api/src/extension-api.d.ts:1592"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1582",children:"packages/extension-api/src/extension-api.d.ts:1582"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1622",children:"packages/extension-api/src/extension-api.d.ts:1622"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1613",children:"packages/extension-api/src/extension-api.d.ts:1613"})})]})}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 diff --git a/assets/js/7cde3c49.27b6c1e9.js b/assets/js/7cde3c49.1e24b5c4.js similarity index 94% rename from assets/js/7cde3c49.27b6c1e9.js rename to assets/js/7cde3c49.1e24b5c4.js index 5dc60550a50..737fd13a4d5 100644 --- a/assets/js/7cde3c49.27b6c1e9.js +++ b/assets/js/7cde3c49.1e24b5c4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37836],{30393:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3246",children:"packages/extension-api/src/extension-api.d.ts:3246"})})]})}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],{30393:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3246",children:"packages/extension-api/src/extension-api.d.ts:3246"})})]})}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.707314e8.js b/assets/js/7d9edfb8.6055b87f.js similarity index 89% rename from assets/js/7d9edfb8.707314e8.js rename to assets/js/7d9edfb8.6055b87f.js index 251afb1a83d..f004e9f38a5 100644 --- a/assets/js/7d9edfb8.707314e8.js +++ b/assets/js/7d9edfb8.6055b87f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90125],{38654:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3402",children:"packages/extension-api/src/extension-api.d.ts:3402"})})]})}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],{38654:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3402",children:"packages/extension-api/src/extension-api.d.ts:3402"})})]})}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.dcda2f2a.js b/assets/js/7e2ae3df.c0edaed7.js similarity index 98% rename from assets/js/7e2ae3df.dcda2f2a.js rename to assets/js/7e2ae3df.c0edaed7.js index 857a3bf4762..1f9b7dcec79 100644 --- a/assets/js/7e2ae3df.dcda2f2a.js +++ b/assets/js/7e2ae3df.c0edaed7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28143],{38230:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3769",children:"packages/extension-api/src/extension-api.d.ts:3769"})})]})}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],{38230:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3769",children:"packages/extension-api/src/extension-api.d.ts:3769"})})]})}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.3917ae7c.js b/assets/js/7e5a2776.69c9292a.js similarity index 83% rename from assets/js/7e5a2776.3917ae7c.js rename to assets/js/7e5a2776.69c9292a.js index ff1797b7918..b2c08a14c45 100644 --- a/assets/js/7e5a2776.3917ae7c.js +++ b/assets/js/7e5a2776.69c9292a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51171],{40733:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1486",children:"packages/extension-api/src/extension-api.d.ts:1486"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1487",children:"packages/extension-api/src/extension-api.d.ts:1487"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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],{40733:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=s(24246),r=s(71670);const t={},d="Interface: FileSystemWatcher",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1486",children:"packages/extension-api/src/extension-api.d.ts:1486"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1487",children:"packages/extension-api/src/extension-api.d.ts:1487"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:()=>c,a:()=>d});var i=s(27378);const r={},t=i.createContext(r);function d(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:d(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7f0476bd.a383aec4.js b/assets/js/7f0476bd.86bfe3bb.js similarity index 83% rename from assets/js/7f0476bd.a383aec4.js rename to assets/js/7f0476bd.86bfe3bb.js index 2a32f836cdd..4042430b065 100644 --- a/assets/js/7f0476bd.a383aec4.js +++ b/assets/js/7f0476bd.86bfe3bb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{7095:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=n(24246),c=n(71670);const r={},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"}},a={},d=[{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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1546",children:"packages/extension-api/src/extension-api.d.ts:1546"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1523",children:"packages/extension-api/src/extension-api.d.ts:1523"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1530",children:"packages/extension-api/src/extension-api.d.ts:1530"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1515",children:"packages/extension-api/src/extension-api.d.ts:1515"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1540",children:"packages/extension-api/src/extension-api.d.ts:1540"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1535",children:"packages/extension-api/src/extension-api.d.ts:1535"})})]})}function h(e={}){const{wrapper:s}={...(0,c.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 c={},r=i.createContext(c);function t(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(c):e.components||c:t(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45346],{7095:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1546",children:"packages/extension-api/src/extension-api.d.ts:1546"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1523",children:"packages/extension-api/src/extension-api.d.ts:1523"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1530",children:"packages/extension-api/src/extension-api.d.ts:1530"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1515",children:"packages/extension-api/src/extension-api.d.ts:1515"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1540",children:"packages/extension-api/src/extension-api.d.ts:1540"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1535",children:"packages/extension-api/src/extension-api.d.ts:1535"})})]})}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.70e39307.js b/assets/js/7fa133e1.8973d732.js similarity index 88% rename from assets/js/7fa133e1.70e39307.js rename to assets/js/7fa133e1.8973d732.js index f48e85a0047..2fd3b18be04 100644 --- a/assets/js/7fa133e1.70e39307.js +++ b/assets/js/7fa133e1.8973d732.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[31512],{28204:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1188",children:"packages/extension-api/src/extension-api.d.ts:1188"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1192",children:"packages/extension-api/src/extension-api.d.ts:1192"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1196",children:"packages/extension-api/src/extension-api.d.ts:1196"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1200",children:"packages/extension-api/src/extension-api.d.ts:1200"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1184",children:"packages/extension-api/src/extension-api.d.ts:1184"})})]})}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],{28204:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1188",children:"packages/extension-api/src/extension-api.d.ts:1188"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1192",children:"packages/extension-api/src/extension-api.d.ts:1192"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1196",children:"packages/extension-api/src/extension-api.d.ts:1196"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1200",children:"packages/extension-api/src/extension-api.d.ts:1200"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1184",children:"packages/extension-api/src/extension-api.d.ts:1184"})})]})}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.54d9a025.js b/assets/js/814402d7.5888db0c.js similarity index 87% rename from assets/js/814402d7.54d9a025.js rename to assets/js/814402d7.5888db0c.js index 493e760e350..08063613175 100644 --- a/assets/js/814402d7.54d9a025.js +++ b/assets/js/814402d7.5888db0c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{87574:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3650",children:"packages/extension-api/src/extension-api.d.ts:3650"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3662",children:"packages/extension-api/src/extension-api.d.ts:3662"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3655",children:"packages/extension-api/src/extension-api.d.ts:3655"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70985],{87574:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3650",children:"packages/extension-api/src/extension-api.d.ts:3650"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3662",children:"packages/extension-api/src/extension-api.d.ts:3662"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3655",children:"packages/extension-api/src/extension-api.d.ts:3655"})})]})}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 diff --git a/assets/js/814d49b7.06e8b7ff.js b/assets/js/814d49b7.480d3aa6.js similarity index 79% rename from assets/js/814d49b7.06e8b7ff.js rename to assets/js/814d49b7.480d3aa6.js index db52177d62c..39f0c47a13a 100644 --- a/assets/js/814d49b7.06e8b7ff.js +++ b/assets/js/814d49b7.480d3aa6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{52994:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var i=s(24246),o=s(71670);const c={},t="Interface: CliToolUpdateOptions",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4140",children:"packages/extension-api/src/extension-api.d.ts:4140"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4142",children:"packages/extension-api/src/extension-api.d.ts:4142"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4141",children:"packages/extension-api/src/extension-api.d.ts:4141"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4143",children:"packages/extension-api/src/extension-api.d.ts:4143"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4139",children:"packages/extension-api/src/extension-api.d.ts:4139"})})]})}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:()=>r,a:()=>t});var i=s(27378);const o={},c=i.createContext(o);function t(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(o):e.components||o:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[125],{52994:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4140",children:"packages/extension-api/src/extension-api.d.ts:4140"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4142",children:"packages/extension-api/src/extension-api.d.ts:4142"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4141",children:"packages/extension-api/src/extension-api.d.ts:4141"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4143",children:"packages/extension-api/src/extension-api.d.ts:4143"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4139",children:"packages/extension-api/src/extension-api.d.ts:4139"})})]})}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.7ce3d6c2.js b/assets/js/81b69ac7.62964794.js similarity index 88% rename from assets/js/81b69ac7.7ce3d6c2.js rename to assets/js/81b69ac7.62964794.js index d3dfcc4228d..931dfb18fed 100644 --- a/assets/js/81b69ac7.7ce3d6c2.js +++ b/assets/js/81b69ac7.62964794.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{49911:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>a});var r=i(24246),c=i(71670);const t={},o="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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L442",children:"packages/extension-api/src/extension-api.d.ts:442"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}function h(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,i)=>{i.d(n,{Z:()=>s,a:()=>o});var r=i(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 s(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92786],{49911:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L442",children:"packages/extension-api/src/extension-api.d.ts:442"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}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.e43fa3f9.js b/assets/js/82170cf7.c30d61e4.js similarity index 96% rename from assets/js/82170cf7.e43fa3f9.js rename to assets/js/82170cf7.c30d61e4.js index b8f7d29d54d..5770bc692f9 100644 --- a/assets/js/82170cf7.e43fa3f9.js +++ b/assets/js/82170cf7.c30d61e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28263],{38185:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3459",children:"packages/extension-api/src/extension-api.d.ts:3459"})})]})}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],{38185:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3459",children:"packages/extension-api/src/extension-api.d.ts:3459"})})]})}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.a422a44d.js b/assets/js/825ec378.a3e11fa8.js similarity index 81% rename from assets/js/825ec378.a422a44d.js rename to assets/js/825ec378.a3e11fa8.js index d7ae7ad022a..bc58cb07bbe 100644 --- a/assets/js/825ec378.a422a44d.js +++ b/assets/js/825ec378.a3e11fa8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{91525:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=i(24246),c=i(71670);const s={},r="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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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,c.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:()=>r});var t=i(27378);const c={},s=t.createContext(c);function r(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(c):e.components||c:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83039],{91525:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var t=i(24246),s=i(71670);const r={},o="Function: buildImage()",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},71670:(e,n,i)=>{i.d(n,{Z:()=>c,a:()=>o});var t=i(27378);const s={},r=t.createContext(s);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(s):e.components||s:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8519c2b0.ebd3c614.js b/assets/js/8519c2b0.d3273508.js similarity index 98% rename from assets/js/8519c2b0.ebd3c614.js rename to assets/js/8519c2b0.d3273508.js index 66657fd6767..d2eaf21cc85 100644 --- a/assets/js/8519c2b0.ebd3c614.js +++ b/assets/js/8519c2b0.d3273508.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40569],{93020:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1726",children:"packages/extension-api/src/extension-api.d.ts:1726"})})]})}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],{93020:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1726",children:"packages/extension-api/src/extension-api.d.ts:1726"})})]})}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.4801b375.js b/assets/js/86e64757.a4a4653e.js similarity index 94% rename from assets/js/86e64757.4801b375.js rename to assets/js/86e64757.a4a4653e.js index 0484206adf2..48d6a6be9de 100644 --- a/assets/js/86e64757.4801b375.js +++ b/assets/js/86e64757.a4a4653e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36075],{87321:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3809",children:"packages/extension-api/src/extension-api.d.ts:3809"})})]})}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],{87321:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3809",children:"packages/extension-api/src/extension-api.d.ts:3809"})})]})}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.084c6efe.js b/assets/js/86f8c256.02f59dd6.js similarity index 91% rename from assets/js/86f8c256.084c6efe.js rename to assets/js/86f8c256.02f59dd6.js index 148929d40f1..5b273c670b0 100644 --- a/assets/js/86f8c256.084c6efe.js +++ b/assets/js/86f8c256.02f59dd6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{57895:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2045",children:"packages/extension-api/src/extension-api.d.ts:2045"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2023",children:"packages/extension-api/src/extension-api.d.ts:2023"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2000",children:"packages/extension-api/src/extension-api.d.ts:2000"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2001",children:"packages/extension-api/src/extension-api.d.ts:2001"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1999",children:"packages/extension-api/src/extension-api.d.ts:1999"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2022",children:"packages/extension-api/src/extension-api.d.ts:2022"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2049",children:"packages/extension-api/src/extension-api.d.ts:2049"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1994",children:"packages/extension-api/src/extension-api.d.ts:1994"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2046",children:"packages/extension-api/src/extension-api.d.ts:2046"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1996",children:"packages/extension-api/src/extension-api.d.ts:1996"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1995",children:"packages/extension-api/src/extension-api.d.ts:1995"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2048",children:"packages/extension-api/src/extension-api.d.ts:2048"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29234],{57895:(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: 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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2045",children:"packages/extension-api/src/extension-api.d.ts:2045"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2023",children:"packages/extension-api/src/extension-api.d.ts:2023"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2000",children:"packages/extension-api/src/extension-api.d.ts:2000"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2001",children:"packages/extension-api/src/extension-api.d.ts:2001"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1999",children:"packages/extension-api/src/extension-api.d.ts:1999"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2022",children:"packages/extension-api/src/extension-api.d.ts:2022"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2049",children:"packages/extension-api/src/extension-api.d.ts:2049"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1994",children:"packages/extension-api/src/extension-api.d.ts:1994"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2046",children:"packages/extension-api/src/extension-api.d.ts:2046"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1996",children:"packages/extension-api/src/extension-api.d.ts:1996"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1995",children:"packages/extension-api/src/extension-api.d.ts:1995"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2057",children:"packages/extension-api/src/extension-api.d.ts:2057"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2047",children:"packages/extension-api/src/extension-api.d.ts:2047"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2048",children:"packages/extension-api/src/extension-api.d.ts:2048"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1992",children:"packages/extension-api/src/extension-api.d.ts:1992"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1993",children:"packages/extension-api/src/extension-api.d.ts:1993"})})]})}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/871ce139.f398b22a.js b/assets/js/871ce139.0d373167.js similarity index 94% rename from assets/js/871ce139.f398b22a.js rename to assets/js/871ce139.0d373167.js index 1b9ffbbcaf9..414dd19a390 100644 --- a/assets/js/871ce139.f398b22a.js +++ b/assets/js/871ce139.0d373167.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[91893],{15371:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3165",children:"packages/extension-api/src/extension-api.d.ts:3165"})})]})}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],{15371:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3165",children:"packages/extension-api/src/extension-api.d.ts:3165"})})]})}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.8cc4705d.js b/assets/js/874690d0.01d81122.js similarity index 83% rename from assets/js/874690d0.8cc4705d.js rename to assets/js/874690d0.01d81122.js index 993bf896f56..5eddbb84f99 100644 --- a/assets/js/874690d0.8cc4705d.js +++ b/assets/js/874690d0.01d81122.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{72077:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),c=s(71670);const t={},r="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"}},a={},d=[{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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1319",children:"packages/extension-api/src/extension-api.d.ts:1319"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1347",children:"packages/extension-api/src/extension-api.d.ts:1347"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1352",children:"packages/extension-api/src/extension-api.d.ts:1352"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1343",children:"packages/extension-api/src/extension-api.d.ts:1343"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1338",children:"packages/extension-api/src/extension-api.d.ts:1338"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1324",children:"packages/extension-api/src/extension-api.d.ts:1324"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1328",children:"packages/extension-api/src/extension-api.d.ts:1328"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1332",children:"packages/extension-api/src/extension-api.d.ts:1332"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1366",children:"packages/extension-api/src/extension-api.d.ts:1366"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1360",children:"packages/extension-api/src/extension-api.d.ts:1360"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1356",children:"packages/extension-api/src/extension-api.d.ts:1356"})})]})}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:()=>r});var i=s(27378);const c={},t=i.createContext(c);function r(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(c):e.components||c:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58216],{72077:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1319",children:"packages/extension-api/src/extension-api.d.ts:1319"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1347",children:"packages/extension-api/src/extension-api.d.ts:1347"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1352",children:"packages/extension-api/src/extension-api.d.ts:1352"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1343",children:"packages/extension-api/src/extension-api.d.ts:1343"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1338",children:"packages/extension-api/src/extension-api.d.ts:1338"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1324",children:"packages/extension-api/src/extension-api.d.ts:1324"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1328",children:"packages/extension-api/src/extension-api.d.ts:1328"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1332",children:"packages/extension-api/src/extension-api.d.ts:1332"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1366",children:"packages/extension-api/src/extension-api.d.ts:1366"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1360",children:"packages/extension-api/src/extension-api.d.ts:1360"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1356",children:"packages/extension-api/src/extension-api.d.ts:1356"})})]})}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 diff --git a/assets/js/8785b74d.047daa5f.js b/assets/js/8785b74d.502b27a9.js similarity index 88% rename from assets/js/8785b74d.047daa5f.js rename to assets/js/8785b74d.502b27a9.js index 2e689196bff..599816a3759 100644 --- a/assets/js/8785b74d.047daa5f.js +++ b/assets/js/8785b74d.502b27a9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[83672],{32084:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var s=r(24246),t=r(71670);const i={},c="Interface: TelemetryLogger",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3989",children:"packages/extension-api/src/extension-api.d.ts:3989"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3984",children:"packages/extension-api/src/extension-api.d.ts:3984"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3979",children:"packages/extension-api/src/extension-api.d.ts:3979"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4024",children:"packages/extension-api/src/extension-api.d.ts:4024"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4011",children:"packages/extension-api/src/extension-api.d.ts:4011"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4019",children:"packages/extension-api/src/extension-api.d.ts:4019"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4000",children:"packages/extension-api/src/extension-api.d.ts:4000"})})]})}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:()=>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([[83672],{32084:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3989",children:"packages/extension-api/src/extension-api.d.ts:3989"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3984",children:"packages/extension-api/src/extension-api.d.ts:3984"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3979",children:"packages/extension-api/src/extension-api.d.ts:3979"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4024",children:"packages/extension-api/src/extension-api.d.ts:4024"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4011",children:"packages/extension-api/src/extension-api.d.ts:4011"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4019",children:"packages/extension-api/src/extension-api.d.ts:4019"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4000",children:"packages/extension-api/src/extension-api.d.ts:4000"})})]})}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 diff --git a/assets/js/878aa0e7.1137017f.js b/assets/js/878aa0e7.44b40092.js similarity index 92% rename from assets/js/878aa0e7.1137017f.js rename to assets/js/878aa0e7.44b40092.js index 5411118f5cc..ee462613e16 100644 --- a/assets/js/878aa0e7.1137017f.js +++ b/assets/js/878aa0e7.44b40092.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{55606:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L776",children:"packages/extension-api/src/extension-api.d.ts:776"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16467],{55606:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L776",children:"packages/extension-api/src/extension-api.d.ts:776"})})]})}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 diff --git a/assets/js/87a5fc8a.67a241ca.js b/assets/js/87a5fc8a.1e4205ea.js similarity index 78% rename from assets/js/87a5fc8a.67a241ca.js rename to assets/js/87a5fc8a.1e4205ea.js index 7f88ac2ad4a..9ed866e7c0d 100644 --- a/assets/js/87a5fc8a.67a241ca.js +++ b/assets/js/87a5fc8a.1e4205ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{81089:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2879",children:"packages/extension-api/src/extension-api.d.ts:2879"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61573],{81089:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2879",children:"packages/extension-api/src/extension-api.d.ts:2879"})})]})}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 diff --git a/assets/js/883e2c3c.8eb2cc4a.js b/assets/js/883e2c3c.8eb2cc4a.js deleted file mode 100644 index ca1aa436b97..00000000000 --- a/assets/js/883e2c3c.8eb2cc4a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{70830:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3499",children:"packages/extension-api/src/extension-api.d.ts:3499"})})]})}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/883e2c3c.9ebdc5dc.js b/assets/js/883e2c3c.9ebdc5dc.js new file mode 100644 index 00000000000..70839774344 --- /dev/null +++ b/assets/js/883e2c3c.9ebdc5dc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53479],{70830:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3499",children:"packages/extension-api/src/extension-api.d.ts:3499"})})]})}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/8a864d1e.9c70898c.js b/assets/js/8a864d1e.784fc5c2.js similarity index 94% rename from assets/js/8a864d1e.9c70898c.js rename to assets/js/8a864d1e.784fc5c2.js index f3df8b316d8..53101ee87eb 100644 --- a/assets/js/8a864d1e.9c70898c.js +++ b/assets/js/8a864d1e.784fc5c2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68974],{97197:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L327",children:"packages/extension-api/src/extension-api.d.ts:327"})})]})}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],{97197:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L327",children:"packages/extension-api/src/extension-api.d.ts:327"})})]})}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.08879828.js b/assets/js/8abd0ba5.08879828.js deleted file mode 100644 index 608c165cb6a..00000000000 --- a/assets/js/8abd0ba5.08879828.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{8972:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var c=t(24246),i=t(71670);const s={},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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-custompicksectionitem",children:"Interface: CustomPickSectionItem"}),"\n",(0,c.jsx)(n.p,{children:"Represents an item that can be selected from\na list of items."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"content",children:"content?"}),"\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:"content"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1168",children:"packages/extension-api/src/extension-api.d.ts:1168"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"markdowncontent",children:"markDownContent?"}),"\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:"markDownContent"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"A human-readable string which is rendered in a separate line. (Markdown format)"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1173",children:"packages/extension-api/src/extension-api.d.ts:1173"})}),"\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.strong,{children:"title"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"A human-readable string which is rendered prominent."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1163",children:"packages/extension-api/src/extension-api.d.ts:1163"})})]})}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,t)=>{t.d(n,{Z:()=>o,a:()=>r});var c=t(27378);const i={},s=c.createContext(i);function r(e){const n=c.useContext(s);return c.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),c.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8abd0ba5.56eabc98.js b/assets/js/8abd0ba5.56eabc98.js new file mode 100644 index 00000000000..08193c64131 --- /dev/null +++ b/assets/js/8abd0ba5.56eabc98.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1516],{8972:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1168",children:"packages/extension-api/src/extension-api.d.ts:1168"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1173",children:"packages/extension-api/src/extension-api.d.ts:1173"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1163",children:"packages/extension-api/src/extension-api.d.ts:1163"})})]})}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.4e1ae04b.js b/assets/js/8b4ba22f.1df87199.js similarity index 89% rename from assets/js/8b4ba22f.4e1ae04b.js rename to assets/js/8b4ba22f.1df87199.js index 43c9703e17c..ffe4ececcd3 100644 --- a/assets/js/8b4ba22f.4e1ae04b.js +++ b/assets/js/8b4ba22f.1df87199.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60564],{346:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4147",children:"packages/extension-api/src/extension-api.d.ts:4147"})})]})}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],{346:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4148",children:"packages/extension-api/src/extension-api.d.ts:4148"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4147",children:"packages/extension-api/src/extension-api.d.ts:4147"})})]})}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.e2d90aec.js b/assets/js/8c6c72f9.f22e6918.js similarity index 94% rename from assets/js/8c6c72f9.e2d90aec.js rename to assets/js/8c6c72f9.f22e6918.js index 9c8bf338cf5..0c525e4ed0c 100644 --- a/assets/js/8c6c72f9.e2d90aec.js +++ b/assets/js/8c6c72f9.f22e6918.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63707],{50243:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})})]})}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],{50243:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L468",children:"packages/extension-api/src/extension-api.d.ts:468"})})]})}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.48d13c40.js b/assets/js/8c8ef21f.12e2f97f.js similarity index 90% rename from assets/js/8c8ef21f.48d13c40.js rename to assets/js/8c8ef21f.12e2f97f.js index 29d6af74493..6b4361cc80a 100644 --- a/assets/js/8c8ef21f.48d13c40.js +++ b/assets/js/8c8ef21f.12e2f97f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80954],{46629:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L466",children:"packages/extension-api/src/extension-api.d.ts:466"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})})]})}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],{46629:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L466",children:"packages/extension-api/src/extension-api.d.ts:466"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L464",children:"packages/extension-api/src/extension-api.d.ts:464"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L465",children:"packages/extension-api/src/extension-api.d.ts:465"})})]})}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.f9de001c.js b/assets/js/8cb0269b.6ab6ed9d.js similarity index 94% rename from assets/js/8cb0269b.f9de001c.js rename to assets/js/8cb0269b.6ab6ed9d.js index 7ef9711ab37..08aa5edbf23 100644 --- a/assets/js/8cb0269b.f9de001c.js +++ b/assets/js/8cb0269b.6ab6ed9d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35281],{88782:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1407",children:"packages/extension-api/src/extension-api.d.ts:1407"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1419",children:"packages/extension-api/src/extension-api.d.ts:1419"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1439",children:"packages/extension-api/src/extension-api.d.ts:1439"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1429",children:"packages/extension-api/src/extension-api.d.ts:1429"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1424",children:"packages/extension-api/src/extension-api.d.ts:1424"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1434",children:"packages/extension-api/src/extension-api.d.ts:1434"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1413",children:"packages/extension-api/src/extension-api.d.ts:1413"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1478",children:"packages/extension-api/src/extension-api.d.ts:1478"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1455",children:"packages/extension-api/src/extension-api.d.ts:1455"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1392",children:"packages/extension-api/src/extension-api.d.ts:1392"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1386",children:"packages/extension-api/src/extension-api.d.ts:1386"})})]})}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],{88782:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1407",children:"packages/extension-api/src/extension-api.d.ts:1407"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1419",children:"packages/extension-api/src/extension-api.d.ts:1419"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1439",children:"packages/extension-api/src/extension-api.d.ts:1439"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1429",children:"packages/extension-api/src/extension-api.d.ts:1429"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1424",children:"packages/extension-api/src/extension-api.d.ts:1424"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1434",children:"packages/extension-api/src/extension-api.d.ts:1434"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1413",children:"packages/extension-api/src/extension-api.d.ts:1413"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1478",children:"packages/extension-api/src/extension-api.d.ts:1478"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1455",children:"packages/extension-api/src/extension-api.d.ts:1455"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1392",children:"packages/extension-api/src/extension-api.d.ts:1392"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1386",children:"packages/extension-api/src/extension-api.d.ts:1386"})})]})}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 diff --git a/assets/js/8ccdb99f.91d0696e.js b/assets/js/8ccdb99f.f12d1b93.js similarity index 80% rename from assets/js/8ccdb99f.91d0696e.js rename to assets/js/8ccdb99f.f12d1b93.js index 3ee3eb2f55d..6b2e9e50af1 100644 --- a/assets/js/8ccdb99f.91d0696e.js +++ b/assets/js/8ccdb99f.f12d1b93.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{38630:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2205",children:"packages/extension-api/src/extension-api.d.ts:2205"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6639],{38630:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2205",children:"packages/extension-api/src/extension-api.d.ts:2205"})})]})}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 diff --git a/assets/js/8dbb6800.76f64877.js b/assets/js/8dbb6800.45927e47.js similarity index 95% rename from assets/js/8dbb6800.76f64877.js rename to assets/js/8dbb6800.45927e47.js index 67029c3c327..185c018a414 100644 --- a/assets/js/8dbb6800.76f64877.js +++ b/assets/js/8dbb6800.45927e47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[46738],{62926:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3489",children:"packages/extension-api/src/extension-api.d.ts:3489"})})]})}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],{62926:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3489",children:"packages/extension-api/src/extension-api.d.ts:3489"})})]})}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.0dcb1c41.js b/assets/js/8eeedb31.e5937b2e.js similarity index 97% rename from assets/js/8eeedb31.0dcb1c41.js rename to assets/js/8eeedb31.e5937b2e.js index aadda9060bb..55f47d9fa59 100644 --- a/assets/js/8eeedb31.0dcb1c41.js +++ b/assets/js/8eeedb31.e5937b2e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[28682],{32799:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1694",children:"packages/extension-api/src/extension-api.d.ts:1694"})})]})}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],{32799:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1694",children:"packages/extension-api/src/extension-api.d.ts:1694"})})]})}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.e9b1d90d.js b/assets/js/905702d2.5e8228a9.js similarity index 95% rename from assets/js/905702d2.e9b1d90d.js rename to assets/js/905702d2.5e8228a9.js index a2009900317..09afff2ec88 100644 --- a/assets/js/905702d2.e9b1d90d.js +++ b/assets/js/905702d2.5e8228a9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[38056],{29700:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L754",children:"packages/extension-api/src/extension-api.d.ts:754"})})]})}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],{29700:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L754",children:"packages/extension-api/src/extension-api.d.ts:754"})})]})}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.06c9e3ab.js b/assets/js/91008145.c8308c72.js similarity index 78% rename from assets/js/91008145.06c9e3ab.js rename to assets/js/91008145.c8308c72.js index 711fe7fdf17..582518afa0c 100644 --- a/assets/js/91008145.06c9e3ab.js +++ b/assets/js/91008145.c8308c72.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42423],{87811:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3483",children:"packages/extension-api/src/extension-api.d.ts:3483"})})]})}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([[42423],{87811:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3483",children:"packages/extension-api/src/extension-api.d.ts:3483"})})]})}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 diff --git a/assets/js/91392348.d14ce556.js b/assets/js/91392348.cb0871b5.js similarity index 94% rename from assets/js/91392348.d14ce556.js rename to assets/js/91392348.cb0871b5.js index 6394c6e6ccd..a17e8f6a0b1 100644 --- a/assets/js/91392348.d14ce556.js +++ b/assets/js/91392348.cb0871b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60637],{47084:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})})]})}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],{47084:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L643",children:"packages/extension-api/src/extension-api.d.ts:643"})})]})}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.0e2fe2f5.js b/assets/js/91fe1403.e4374f71.js similarity index 65% rename from assets/js/91fe1403.0e2fe2f5.js rename to assets/js/91fe1403.e4374f71.js index 6019c008361..b444dac486d 100644 --- a/assets/js/91fe1403.0e2fe2f5.js +++ b/assets/js/91fe1403.e4374f71.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92916],{53968:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>l});var s=a(24246),c=a(71670);const r={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}function d(e={}){const{wrapper:n}={...(0,c.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 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 t(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([[92916],{53968:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3837",children:"packages/extension-api/src/extension-api.d.ts:3837"})})]})}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 diff --git a/assets/js/920c2ac2.8354c110.js b/assets/js/920c2ac2.942eb776.js similarity index 91% rename from assets/js/920c2ac2.8354c110.js rename to assets/js/920c2ac2.942eb776.js index 2319d56f96d..80b8d742665 100644 --- a/assets/js/920c2ac2.8354c110.js +++ b/assets/js/920c2ac2.942eb776.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{6207:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>r,toc:()=>o});var s=i(24246),c=i(71670);const l={},t="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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2961",children:"packages/extension-api/src/extension-api.d.ts:2961"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2962",children:"packages/extension-api/src/extension-api.d.ts:2962"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2957",children:"packages/extension-api/src/extension-api.d.ts:2957"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2958",children:"packages/extension-api/src/extension-api.d.ts:2958"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2955",children:"packages/extension-api/src/extension-api.d.ts:2955"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2963",children:"packages/extension-api/src/extension-api.d.ts:2963"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2924",children:"packages/extension-api/src/extension-api.d.ts:2924"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2956",children:"packages/extension-api/src/extension-api.d.ts:2956"})})]})}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,i)=>{i.d(n,{Z:()=>r,a:()=>t});var s=i(27378);const c={},l=s.createContext(c);function t(e){const n=s.useContext(l);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:t(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2281],{6207:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2961",children:"packages/extension-api/src/extension-api.d.ts:2961"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2962",children:"packages/extension-api/src/extension-api.d.ts:2962"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2957",children:"packages/extension-api/src/extension-api.d.ts:2957"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2958",children:"packages/extension-api/src/extension-api.d.ts:2958"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2955",children:"packages/extension-api/src/extension-api.d.ts:2955"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2963",children:"packages/extension-api/src/extension-api.d.ts:2963"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2924",children:"packages/extension-api/src/extension-api.d.ts:2924"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2956",children:"packages/extension-api/src/extension-api.d.ts:2956"})})]})}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.031b1e85.js b/assets/js/927c84a6.39ba7da0.js similarity index 75% rename from assets/js/927c84a6.031b1e85.js rename to assets/js/927c84a6.39ba7da0.js index 7e4361ea290..76f8f7a5d5c 100644 --- a/assets/js/927c84a6.031b1e85.js +++ b/assets/js/927c84a6.39ba7da0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{78986:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L471",children:"packages/extension-api/src/extension-api.d.ts:471"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8039],{78986:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var s=t(24246),i=t(71670);const r={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L471",children:"packages/extension-api/src/extension-api.d.ts:471"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L472",children:"packages/extension-api/src/extension-api.d.ts:472"})})]})}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:()=>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/9286a297.c9e34264.js b/assets/js/9286a297.20c956d0.js similarity index 98% rename from assets/js/9286a297.c9e34264.js rename to assets/js/9286a297.20c956d0.js index bb4470b8e94..1f4f14eb7d1 100644 --- a/assets/js/9286a297.c9e34264.js +++ b/assets/js/9286a297.20c956d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21360],{98563:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4310",children:"packages/extension-api/src/extension-api.d.ts:4310"})})]})}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],{98563:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4310",children:"packages/extension-api/src/extension-api.d.ts:4310"})})]})}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 diff --git a/assets/js/92b08985.d4e9a8dd.js b/assets/js/92b08985.f6d740d4.js similarity index 79% rename from assets/js/92b08985.d4e9a8dd.js rename to assets/js/92b08985.f6d740d4.js index 1de66bfb21d..6ea88fbb190 100644 --- a/assets/js/92b08985.d4e9a8dd.js +++ b/assets/js/92b08985.f6d740d4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57321],{3849:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2066",children:"packages/extension-api/src/extension-api.d.ts:2066"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2068",children:"packages/extension-api/src/extension-api.d.ts:2068"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2069",children:"packages/extension-api/src/extension-api.d.ts:2069"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2067",children:"packages/extension-api/src/extension-api.d.ts:2067"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2065",children:"packages/extension-api/src/extension-api.d.ts:2065"})})]})}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],{3849:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var r=s(24246),i=s(71670);const t={},o="Interface: NetworkContainer",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2066",children:"packages/extension-api/src/extension-api.d.ts:2066"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2068",children:"packages/extension-api/src/extension-api.d.ts:2068"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2069",children:"packages/extension-api/src/extension-api.d.ts:2069"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2067",children:"packages/extension-api/src/extension-api.d.ts:2067"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2065",children:"packages/extension-api/src/extension-api.d.ts:2065"})})]})}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/92d7df62.f0715142.js b/assets/js/92d7df62.e9f66d35.js similarity index 95% rename from assets/js/92d7df62.f0715142.js rename to assets/js/92d7df62.e9f66d35.js index 6cb7fc58512..e5fcd8d2ee8 100644 --- a/assets/js/92d7df62.f0715142.js +++ b/assets/js/92d7df62.e9f66d35.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2353],{61654:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}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],{61654:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L460",children:"packages/extension-api/src/extension-api.d.ts:460"})})]})}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.bbc60558.js b/assets/js/931e3b0a.0e22c4e0.js similarity index 91% rename from assets/js/931e3b0a.bbc60558.js rename to assets/js/931e3b0a.0e22c4e0.js index 3c1a6c889d5..4ab5556ca13 100644 --- a/assets/js/931e3b0a.bbc60558.js +++ b/assets/js/931e3b0a.0e22c4e0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[55904],{9958:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})})]})}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],{9958:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2190",children:"packages/extension-api/src/extension-api.d.ts:2190"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2191",children:"packages/extension-api/src/extension-api.d.ts:2191"})})]})}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.a5e419d6.js b/assets/js/94324b0e.8f4dc904.js similarity index 97% rename from assets/js/94324b0e.a5e419d6.js rename to assets/js/94324b0e.8f4dc904.js index 3b69c266d33..fe1e9179590 100644 --- a/assets/js/94324b0e.a5e419d6.js +++ b/assets/js/94324b0e.8f4dc904.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76267],{73726:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3490",children:"packages/extension-api/src/extension-api.d.ts:3490"})})]})}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],{73726:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3490",children:"packages/extension-api/src/extension-api.d.ts:3490"})})]})}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.8116ae11.js b/assets/js/95646edb.8f4b9060.js similarity index 86% rename from assets/js/95646edb.8116ae11.js rename to assets/js/95646edb.8f4b9060.js index a549256f3c7..2d1f4362b14 100644 --- a/assets/js/95646edb.8116ae11.js +++ b/assets/js/95646edb.8f4b9060.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{81867:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66e3],{81867:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3481",children:"packages/extension-api/src/extension-api.d.ts:3481"})})]})}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 diff --git a/assets/js/97c7db18.d9f8a791.js b/assets/js/97c7db18.cc515e1e.js similarity index 82% rename from assets/js/97c7db18.d9f8a791.js rename to assets/js/97c7db18.cc515e1e.js index e77200d24c6..72db191a4e7 100644 --- a/assets/js/97c7db18.d9f8a791.js +++ b/assets/js/97c7db18.cc515e1e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[52343],{2610:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4268",children:"packages/extension-api/src/extension-api.d.ts:4268"})})]})}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],{2610:(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: navigateToContainerInspect()",r={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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4268",children:"packages/extension-api/src/extension-api.d.ts:4268"})})]})}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:()=>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/97d49594.cd32721d.js b/assets/js/97d49594.9b002882.js similarity index 85% rename from assets/js/97d49594.cd32721d.js rename to assets/js/97d49594.9b002882.js index 253d70b72d2..254d90958e6 100644 --- a/assets/js/97d49594.cd32721d.js +++ b/assets/js/97d49594.9b002882.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{42200:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=i(24246),s=i(71670);const r={},c="Function: inspectContainer()",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3286",children:"packages/extension-api/src/extension-api.d.ts:3286"})})]})}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:()=>o,a:()=>c});var t=i(27378);const s={},r=t.createContext(s);function c(n){const e=t.useContext(r);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(s):n.components||s:c(n.components),t.createElement(r.Provider,{value:e},n.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45708],{42200:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3286",children:"packages/extension-api/src/extension-api.d.ts:3286"})})]})}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.57b4c59a.js b/assets/js/97eb992d.57b4c59a.js deleted file mode 100644 index a3e5fd20e33..00000000000 --- a/assets/js/97eb992d.57b4c59a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{85506:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>a});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-networkinspectinfo",children:"Interface: NetworkInspectInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"attachable",children:"Attachable"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Attachable"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2090",children:"packages/extension-api/src/extension-api.d.ts:2090"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"configfrom",children:"ConfigFrom?"}),"\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:"ConfigFrom"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"network",children:"Network"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Network"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2092",children:"packages/extension-api/src/extension-api.d.ts:2092"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"configonly",children:"ConfigOnly"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"ConfigOnly"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2093",children:"packages/extension-api/src/extension-api.d.ts:2093"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"containers",children:"Containers?"}),"\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:"Containers"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"id"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.a,{href:"/api/interfaces/NetworkContainer",children:(0,c.jsx)(n.code,{children:"NetworkContainer"})})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2094",children:"packages/extension-api/src/extension-api.d.ts:2094"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"created",children:"Created"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Created"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2084",children:"packages/extension-api/src/extension-api.d.ts:2084"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Driver"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2086",children:"packages/extension-api/src/extension-api.d.ts:2086"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enableipv6",children:"EnableIPv6"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"EnableIPv6"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2087",children:"packages/extension-api/src/extension-api.d.ts:2087"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipam",children:"IPAM?"}),"\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:"IPAM"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/IPAM",children:(0,c.jsx)(n.code,{children:"IPAM"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2088",children:"packages/extension-api/src/extension-api.d.ts:2088"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2083",children:"packages/extension-api/src/extension-api.d.ts:2083"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ingress",children:"Ingress"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Ingress"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2091",children:"packages/extension-api/src/extension-api.d.ts:2091"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"internal",children:"Internal"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Internal"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2089",children:"packages/extension-api/src/extension-api.d.ts:2089"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"Labels?"}),"\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:"Labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2096",children:"packages/extension-api/src/extension-api.d.ts:2096"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Name"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2082",children:"packages/extension-api/src/extension-api.d.ts:2082"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"options",children:"Options?"}),"\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:"Options"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2095",children:"packages/extension-api/src/extension-api.d.ts:2095"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Scope"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2085",children:"packages/extension-api/src/extension-api.d.ts:2085"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2079",children:"packages/extension-api/src/extension-api.d.ts:2079"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineName"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2080",children:"packages/extension-api/src/extension-api.d.ts:2080"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginetype",children:"engineType"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineType"}),": ",(0,c.jsx)(n.code,{children:'"docker"'})," | ",(0,c.jsx)(n.code,{children:'"podman"'})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2081",children:"packages/extension-api/src/extension-api.d.ts:2081"})})]})}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:()=>d,a:()=>o});var c=s(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 d(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/97eb992d.76f8898d.js b/assets/js/97eb992d.76f8898d.js new file mode 100644 index 00000000000..7ed25782aec --- /dev/null +++ b/assets/js/97eb992d.76f8898d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53800],{85506:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2086",children:"packages/extension-api/src/extension-api.d.ts:2086"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2083",children:"packages/extension-api/src/extension-api.d.ts:2083"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2082",children:"packages/extension-api/src/extension-api.d.ts:2082"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2079",children:"packages/extension-api/src/extension-api.d.ts:2079"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2080",children:"packages/extension-api/src/extension-api.d.ts:2080"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2081",children:"packages/extension-api/src/extension-api.d.ts:2081"})})]})}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.bdd47abf.js b/assets/js/98ced590.378c769e.js similarity index 95% rename from assets/js/98ced590.bdd47abf.js rename to assets/js/98ced590.378c769e.js index 96c262018e9..5baac3b1767 100644 --- a/assets/js/98ced590.bdd47abf.js +++ b/assets/js/98ced590.378c769e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80325],{62282:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4270",children:"packages/extension-api/src/extension-api.d.ts:4270"})})]})}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],{62282:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4270",children:"packages/extension-api/src/extension-api.d.ts:4270"})})]})}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/9a22c80d.eacafceb.js b/assets/js/9a22c80d.c6afe150.js similarity index 78% rename from assets/js/9a22c80d.eacafceb.js rename to assets/js/9a22c80d.c6afe150.js index 03c4f1eadc2..c332ba54d43 100644 --- a/assets/js/9a22c80d.eacafceb.js +++ b/assets/js/9a22c80d.c6afe150.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92428],{284:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=s(24246),a=s(71670);const o={},i="Variable: all",c={id:"namespaces/extensions/variables/all",title:"Variable: all",description:"const all: readonly Extension\\[]",source:"@site/api/namespaces/extensions/variables/all.md",sourceDirName:"namespaces/extensions/variables",slug:"/namespaces/extensions/variables/all",permalink:"/api/namespaces/extensions/variables/all",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: extensions",permalink:"/api/namespaces/extensions/"},next:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"}},r={},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-all",children:"Variable: all"}),"\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:"all"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"any"}),">[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All extensions currently known to the system."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}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:()=>c,a:()=>i});var t=s(27378);const a={},o=t.createContext(a);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(a):e.components||a:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92428],{284:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=s(24246),a=s(71670);const o={},i="Variable: all",r={id:"namespaces/extensions/variables/all",title:"Variable: all",description:"const all: readonly Extension\\[]",source:"@site/api/namespaces/extensions/variables/all.md",sourceDirName:"namespaces/extensions/variables",slug:"/namespaces/extensions/variables/all",permalink:"/api/namespaces/extensions/variables/all",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Namespace: extensions",permalink:"/api/namespaces/extensions/"},next:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"}},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-all",children:"Variable: all"}),"\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:"all"}),": readonly ",(0,t.jsx)(n.a,{href:"/api/interfaces/Extension",children:(0,t.jsx)(n.code,{children:"Extension"})}),"<",(0,t.jsx)(n.code,{children:"any"}),">[]"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"All extensions currently known to the system."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L240",children:"packages/extension-api/src/extension-api.d.ts:240"})})]})}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:()=>r,a:()=>i});var t=s(27378);const a={},o=t.createContext(a);function i(e){const n=t.useContext(o);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(a):e.components||a:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9af13eab.156a7b02.js b/assets/js/9af13eab.156a7b02.js new file mode 100644 index 00000000000..ad7ae5b3d18 --- /dev/null +++ b/assets/js/9af13eab.156a7b02.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{11573:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L664",children:"packages/extension-api/src/extension-api.d.ts:664"})})]})}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.8b1a8b85.js b/assets/js/9af13eab.8b1a8b85.js deleted file mode 100644 index 317ce6e8e88..00000000000 --- a/assets/js/9af13eab.8b1a8b85.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[45033],{11573:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L664",children:"packages/extension-api/src/extension-api.d.ts:664"})})]})}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.540b6b1f.js b/assets/js/9c540f0b.d4c5b1f6.js similarity index 84% rename from assets/js/9c540f0b.540b6b1f.js rename to assets/js/9c540f0b.d4c5b1f6.js index d284e058c67..3fc006c9018 100644 --- a/assets/js/9c540f0b.540b6b1f.js +++ b/assets/js/9c540f0b.d4c5b1f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[14026],{99460:(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="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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2219",children:"packages/extension-api/src/extension-api.d.ts:2219"})})]})}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([[14026],{99460:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2219",children:"packages/extension-api/src/extension-api.d.ts:2219"})})]})}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 diff --git a/assets/js/9d2d4743.08e8046b.js b/assets/js/9d2d4743.937a6481.js similarity index 94% rename from assets/js/9d2d4743.08e8046b.js rename to assets/js/9d2d4743.937a6481.js index ea30ad44299..1abe1f4b238 100644 --- a/assets/js/9d2d4743.08e8046b.js +++ b/assets/js/9d2d4743.937a6481.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89731],{90190:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L356",children:"packages/extension-api/src/extension-api.d.ts:356"})})]})}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],{90190:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L356",children:"packages/extension-api/src/extension-api.d.ts:356"})})]})}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.cc56139f.js b/assets/js/9d887a11.118c73d9.js similarity index 87% rename from assets/js/9d887a11.cc56139f.js rename to assets/js/9d887a11.118c73d9.js index 7c36bca4a2f..27f9e78f82d 100644 --- a/assets/js/9d887a11.cc56139f.js +++ b/assets/js/9d887a11.118c73d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[24904],{65005:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var i=t(24246),s=t(71670);const c={},r="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})})]})}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:()=>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 a(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([[24904],{65005:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1909",children:"packages/extension-api/src/extension-api.d.ts:1909"})})]})}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.18b5cd30.js b/assets/js/9db962b6.a179e9de.js similarity index 96% rename from assets/js/9db962b6.18b5cd30.js rename to assets/js/9db962b6.a179e9de.js index be591c0afa0..3ca99d86d2e 100644 --- a/assets/js/9db962b6.18b5cd30.js +++ b/assets/js/9db962b6.a179e9de.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41644],{11716:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L661",children:"packages/extension-api/src/extension-api.d.ts:661"})})]})}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],{11716:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L661",children:"packages/extension-api/src/extension-api.d.ts:661"})})]})}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.0c957252.js b/assets/js/9dd60997.45dcc210.js similarity index 96% rename from assets/js/9dd60997.0c957252.js rename to assets/js/9dd60997.45dcc210.js index c4c6dfda21a..078507715dc 100644 --- a/assets/js/9dd60997.0c957252.js +++ b/assets/js/9dd60997.45dcc210.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[76518],{79961:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3726",children:"packages/extension-api/src/extension-api.d.ts:3726"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3745",children:"packages/extension-api/src/extension-api.d.ts:3745"})})]})}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],{79961:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3726",children:"packages/extension-api/src/extension-api.d.ts:3726"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3745",children:"packages/extension-api/src/extension-api.d.ts:3745"})})]})}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.f31d2d23.js b/assets/js/a08dfa31.bd9dc7e6.js similarity index 81% rename from assets/js/a08dfa31.f31d2d23.js rename to assets/js/a08dfa31.bd9dc7e6.js index 48ed273f23e..964c36b2d5a 100644 --- a/assets/js/a08dfa31.f31d2d23.js +++ b/assets/js/a08dfa31.bd9dc7e6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69006],{34649:(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: 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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L324",children:"packages/extension-api/src/extension-api.d.ts:324"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L312",children:"packages/extension-api/src/extension-api.d.ts:312"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L316",children:"packages/extension-api/src/extension-api.d.ts:316"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L313",children:"packages/extension-api/src/extension-api.d.ts:313"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L315",children:"packages/extension-api/src/extension-api.d.ts:315"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L321",children:"packages/extension-api/src/extension-api.d.ts:321"})})]})}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([[69006],{34649:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L324",children:"packages/extension-api/src/extension-api.d.ts:324"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L312",children:"packages/extension-api/src/extension-api.d.ts:312"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L316",children:"packages/extension-api/src/extension-api.d.ts:316"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L313",children:"packages/extension-api/src/extension-api.d.ts:313"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L314",children:"packages/extension-api/src/extension-api.d.ts:314"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L315",children:"packages/extension-api/src/extension-api.d.ts:315"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L321",children:"packages/extension-api/src/extension-api.d.ts:321"})})]})}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.2dc86fba.js b/assets/js/a2c6f402.4f84a827.js similarity index 94% rename from assets/js/a2c6f402.2dc86fba.js rename to assets/js/a2c6f402.4f84a827.js index 4c455dc4f89..98d2ce64fdb 100644 --- a/assets/js/a2c6f402.2dc86fba.js +++ b/assets/js/a2c6f402.4f84a827.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6266],{96550:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L532",children:"packages/extension-api/src/extension-api.d.ts:532"})})]})}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],{96550:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L532",children:"packages/extension-api/src/extension-api.d.ts:532"})})]})}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.1360fe64.js b/assets/js/a2d1ff94.1360fe64.js new file mode 100644 index 00000000000..53c41954dcd --- /dev/null +++ b/assets/js/a2d1ff94.1360fe64.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{89703:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L362",children:"packages/extension-api/src/extension-api.d.ts:362"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L364",children:"packages/extension-api/src/extension-api.d.ts:364"})})]})}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/a2d1ff94.3ac7f07c.js b/assets/js/a2d1ff94.3ac7f07c.js deleted file mode 100644 index 0a6ec034225..00000000000 --- a/assets/js/a2d1ff94.3ac7f07c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41169],{89703:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>s,toc:()=>d});var c=i(24246),r=i(71670);const t={},o="Interface: ContainerProviderConnection",s={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"}},a={},d=[{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,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-containerproviderconnection",children:"Interface: ContainerProviderConnection"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"endpoint",children:"endpoint"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"endpoint"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ContainerProviderConnectionEndpoint",children:(0,c.jsx)(n.code,{children:"ContainerProviderConnectionEndpoint"})})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L362",children:"packages/extension-api/src/extension-api.d.ts:362"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"lifecycle",children:"lifecycle?"}),"\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:"lifecycle"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/ProviderConnectionLifecycle",children:(0,c.jsx)(n.code,{children:"ProviderConnectionLifecycle"})})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L363",children:"packages/extension-api/src/extension-api.d.ts:363"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"name"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"name"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L360",children:"packages/extension-api/src/extension-api.d.ts:360"})}),"\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.strong,{children:"type"}),": ",(0,c.jsx)(n.code,{children:'"docker"'})," | ",(0,c.jsx)(n.code,{children:'"podman"'})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L361",children:"packages/extension-api/src/extension-api.d.ts:361"})}),"\n",(0,c.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(n.h3,{id:"status",children:"status()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"status"}),"(): ",(0,c.jsx)(n.a,{href:"/api/type-aliases/ProviderConnectionStatus",children:(0,c.jsx)(n.code,{children:"ProviderConnectionStatus"})})]}),"\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/type-aliases/ProviderConnectionStatus",children:(0,c.jsx)(n.code,{children:"ProviderConnectionStatus"})})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L364",children:"packages/extension-api/src/extension-api.d.ts:364"})})]})}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,i)=>{i.d(n,{Z:()=>s,a:()=>o});var c=i(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 s(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/a2ffcc0f.685d797c.js b/assets/js/a2ffcc0f.f31f8021.js similarity index 85% rename from assets/js/a2ffcc0f.685d797c.js rename to assets/js/a2ffcc0f.f31f8021.js index 06b484ec220..c978aa7519f 100644 --- a/assets/js/a2ffcc0f.685d797c.js +++ b/assets/js/a2ffcc0f.f31f8021.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{15382:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1933",children:"packages/extension-api/src/extension-api.d.ts:1933"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[51843],{15382:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1933",children:"packages/extension-api/src/extension-api.d.ts:1933"})})]})}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 diff --git a/assets/js/a3002291.926343e4.js b/assets/js/a3002291.0b865e7a.js similarity index 96% rename from assets/js/a3002291.926343e4.js rename to assets/js/a3002291.0b865e7a.js index bf541ba8127..4f7ed7d1a45 100644 --- a/assets/js/a3002291.926343e4.js +++ b/assets/js/a3002291.0b865e7a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36424],{34403:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3484",children:"packages/extension-api/src/extension-api.d.ts:3484"})})]})}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],{34403:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3484",children:"packages/extension-api/src/extension-api.d.ts:3484"})})]})}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.79d37666.js b/assets/js/a30c0d44.a018d460.js similarity index 87% rename from assets/js/a30c0d44.79d37666.js rename to assets/js/a30c0d44.a018d460.js index 4c791939a41..df25423b74b 100644 --- a/assets/js/a30c0d44.79d37666.js +++ b/assets/js/a30c0d44.a018d460.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{16927:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>l});var i=s(24246),o=s(71670);const t={},c="Interface: InputBoxOptions",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L994",children:"packages/extension-api/src/extension-api.d.ts:994"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L978",children:"packages/extension-api/src/extension-api.d.ts:978"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L999",children:"packages/extension-api/src/extension-api.d.ts:999"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L988",children:"packages/extension-api/src/extension-api.d.ts:988"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L983",children:"packages/extension-api/src/extension-api.d.ts:983"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L973",children:"packages/extension-api/src/extension-api.d.ts:973"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L955",children:"packages/extension-api/src/extension-api.d.ts:955"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L960",children:"packages/extension-api/src/extension-api.d.ts:960"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1009",children:"packages/extension-api/src/extension-api.d.ts:1009"})})]})}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:()=>r,a:()=>c});var i=s(27378);const o={},t=i.createContext(o);function c(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(o):e.components||o:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64891],{16927:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var i=s(24246),o=s(71670);const t={},r="Interface: InputBoxOptions",d={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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L994",children:"packages/extension-api/src/extension-api.d.ts:994"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L978",children:"packages/extension-api/src/extension-api.d.ts:978"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L999",children:"packages/extension-api/src/extension-api.d.ts:999"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L988",children:"packages/extension-api/src/extension-api.d.ts:988"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L983",children:"packages/extension-api/src/extension-api.d.ts:983"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L973",children:"packages/extension-api/src/extension-api.d.ts:973"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L955",children:"packages/extension-api/src/extension-api.d.ts:955"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L960",children:"packages/extension-api/src/extension-api.d.ts:960"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L968",children:"packages/extension-api/src/extension-api.d.ts:968"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1009",children:"packages/extension-api/src/extension-api.d.ts:1009"})})]})}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:()=>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 d(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.fcdc7c15.js b/assets/js/a334b453.e27b628b.js similarity index 83% rename from assets/js/a334b453.fcdc7c15.js rename to assets/js/a334b453.e27b628b.js index 250624a9742..a38afbbaa9c 100644 --- a/assets/js/a334b453.fcdc7c15.js +++ b/assets/js/a334b453.e27b628b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[4004],{62806:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var i=t(24246),o=t(71670);const r={},c="Interface: UpdateContainerConnectionEvent",s={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L628",children:"packages/extension-api/src/extension-api.d.ts:628"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L630",children:"packages/extension-api/src/extension-api.d.ts:630"})})]})}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:()=>s,a:()=>c});var i=t(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 s(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([[4004],{62806:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L629",children:"packages/extension-api/src/extension-api.d.ts:629"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L628",children:"packages/extension-api/src/extension-api.d.ts:628"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L630",children:"packages/extension-api/src/extension-api.d.ts:630"})})]})}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.ad3c6bee.js b/assets/js/a38d285e.6ca191ff.js similarity index 92% rename from assets/js/a38d285e.ad3c6bee.js rename to assets/js/a38d285e.6ca191ff.js index 82591713a83..abe2ac4688e 100644 --- a/assets/js/a38d285e.ad3c6bee.js +++ b/assets/js/a38d285e.6ca191ff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[86477],{58782:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L649",children:"packages/extension-api/src/extension-api.d.ts:649"})})]})}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],{58782:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L650",children:"packages/extension-api/src/extension-api.d.ts:650"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L649",children:"packages/extension-api/src/extension-api.d.ts:649"})})]})}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.2cfec750.js b/assets/js/a3f8794a.3c545aad.js similarity index 84% rename from assets/js/a3f8794a.2cfec750.js rename to assets/js/a3f8794a.3c545aad.js index ccf2257d524..dd90e511f76 100644 --- a/assets/js/a3f8794a.2cfec750.js +++ b/assets/js/a3f8794a.3c545aad.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{20120:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>d});var r=t(24246),i=t(71670);const a={},c="Function: createContainer()",s={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3295",children:"packages/extension-api/src/extension-api.d.ts:3295"})})]})}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:()=>s,a:()=>c});var r=t(27378);const i={},a=r.createContext(i);function c(e){const n=r.useContext(a);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(i):e.components||i:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[60334],{20120:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3295",children:"packages/extension-api/src/extension-api.d.ts:3295"})})]})}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.60c6f6ec.js b/assets/js/a4794f2e.9e656809.js similarity index 97% rename from assets/js/a4794f2e.60c6f6ec.js rename to assets/js/a4794f2e.9e656809.js index 17001f60640..8ec735060b5 100644 --- a/assets/js/a4794f2e.60c6f6ec.js +++ b/assets/js/a4794f2e.9e656809.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[11161],{21926:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})})]})}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],{21926:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L733",children:"packages/extension-api/src/extension-api.d.ts:733"})})]})}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.bd4528bd.js b/assets/js/a9fa5b1f.69f96492.js similarity index 80% rename from assets/js/a9fa5b1f.bd4528bd.js rename to assets/js/a9fa5b1f.69f96492.js index 43caac59746..519bc859c09 100644 --- a/assets/js/a9fa5b1f.bd4528bd.js +++ b/assets/js/a9fa5b1f.69f96492.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{51880:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L529",children:"packages/extension-api/src/extension-api.d.ts:529"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[44619],{51880:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L527",children:"packages/extension-api/src/extension-api.d.ts:527"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L529",children:"packages/extension-api/src/extension-api.d.ts:529"})})]})}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 diff --git a/assets/js/ab69fe56.cf5b9b00.js b/assets/js/ab69fe56.f225e782.js similarity index 97% rename from assets/js/ab69fe56.cf5b9b00.js rename to assets/js/ab69fe56.f225e782.js index b985d9220b3..9914edc50d9 100644 --- a/assets/js/ab69fe56.cf5b9b00.js +++ b/assets/js/ab69fe56.f225e782.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25314],{7641:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})})]})}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],{7641:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2233",children:"packages/extension-api/src/extension-api.d.ts:2233"})})]})}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.cff495d6.js b/assets/js/adcef0a2.0841d94f.js similarity index 85% rename from assets/js/adcef0a2.cff495d6.js rename to assets/js/adcef0a2.0841d94f.js index a540fda05ab..34c418adb3e 100644 --- a/assets/js/adcef0a2.cff495d6.js +++ b/assets/js/adcef0a2.0841d94f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[66464],{69741:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4229",children:"packages/extension-api/src/extension-api.d.ts:4229"})})]})}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],{69741:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4229",children:"packages/extension-api/src/extension-api.d.ts:4229"})})]})}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.83931e34.js b/assets/js/adfdec4a.8346af8c.js similarity index 87% rename from assets/js/adfdec4a.83931e34.js rename to assets/js/adfdec4a.8346af8c.js index fa4d4dc5774..1ef28418926 100644 --- a/assets/js/adfdec4a.83931e34.js +++ b/assets/js/adfdec4a.8346af8c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{94053:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,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 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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1227",children:"packages/extension-api/src/extension-api.d.ts:1227"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1215",children:"packages/extension-api/src/extension-api.d.ts:1215"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1219",children:"packages/extension-api/src/extension-api.d.ts:1219"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1223",children:"packages/extension-api/src/extension-api.d.ts:1223"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1239",children:"packages/extension-api/src/extension-api.d.ts:1239"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1247",children:"packages/extension-api/src/extension-api.d.ts:1247"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1211",children:"packages/extension-api/src/extension-api.d.ts:1211"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1261",children:"packages/extension-api/src/extension-api.d.ts:1261"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1255",children:"packages/extension-api/src/extension-api.d.ts:1255"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1251",children:"packages/extension-api/src/extension-api.d.ts:1251"})})]})}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:()=>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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71970],{94053:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1227",children:"packages/extension-api/src/extension-api.d.ts:1227"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1215",children:"packages/extension-api/src/extension-api.d.ts:1215"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1233",children:"packages/extension-api/src/extension-api.d.ts:1233"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1219",children:"packages/extension-api/src/extension-api.d.ts:1219"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1223",children:"packages/extension-api/src/extension-api.d.ts:1223"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1239",children:"packages/extension-api/src/extension-api.d.ts:1239"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1247",children:"packages/extension-api/src/extension-api.d.ts:1247"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1211",children:"packages/extension-api/src/extension-api.d.ts:1211"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1261",children:"packages/extension-api/src/extension-api.d.ts:1261"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1255",children:"packages/extension-api/src/extension-api.d.ts:1255"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1251",children:"packages/extension-api/src/extension-api.d.ts:1251"})})]})}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 diff --git a/assets/js/ae4a775b.bec4eedf.js b/assets/js/ae4a775b.d7111c3f.js similarity index 82% rename from assets/js/ae4a775b.bec4eedf.js rename to assets/js/ae4a775b.d7111c3f.js index fafb32b81bc..c0ef86bef4c 100644 --- a/assets/js/ae4a775b.bec4eedf.js +++ b/assets/js/ae4a775b.d7111c3f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[30901],{54280:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4111",children:"packages/extension-api/src/extension-api.d.ts:4111"})})]})}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],{54280:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4111",children:"packages/extension-api/src/extension-api.d.ts:4111"})})]})}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.6e5d42e8.js b/assets/js/b15eeff9.cc8e877b.js similarity index 84% rename from assets/js/b15eeff9.6e5d42e8.js rename to assets/js/b15eeff9.cc8e877b.js index be07ed691a1..c5509e29a52 100644 --- a/assets/js/b15eeff9.6e5d42e8.js +++ b/assets/js/b15eeff9.cc8e877b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{37749:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=t(24246),o=t(71670);const c={},s="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3542",children:"packages/extension-api/src/extension-api.d.ts:3542"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3547",children:"packages/extension-api/src/extension-api.d.ts:3547"})})]})}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:()=>s});var i=t(27378);const o={},c=i.createContext(o);function s(e){const n=i.useContext(c);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:s(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[67411],{37749:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3542",children:"packages/extension-api/src/extension-api.d.ts:3542"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3547",children:"packages/extension-api/src/extension-api.d.ts:3547"})})]})}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.e60f0fd2.js b/assets/js/b3b7dd16.1590469e.js similarity index 97% rename from assets/js/b3b7dd16.e60f0fd2.js rename to assets/js/b3b7dd16.1590469e.js index 80c975c700a..37781c3cb4b 100644 --- a/assets/js/b3b7dd16.e60f0fd2.js +++ b/assets/js/b3b7dd16.1590469e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[84960],{15614:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1898",children:"packages/extension-api/src/extension-api.d.ts:1898"})})]})}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],{15614:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1898",children:"packages/extension-api/src/extension-api.d.ts:1898"})})]})}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.0b42a8ad.js b/assets/js/b4df9b48.2fc0f68e.js similarity index 84% rename from assets/js/b4df9b48.0b42a8ad.js rename to assets/js/b4df9b48.2fc0f68e.js index ec50f379fc3..f90372bd261 100644 --- a/assets/js/b4df9b48.0b42a8ad.js +++ b/assets/js/b4df9b48.2fc0f68e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35425],{91258:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L721",children:"packages/extension-api/src/extension-api.d.ts:721"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L720",children:"packages/extension-api/src/extension-api.d.ts:720"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}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([[35425],{91258:(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: 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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L721",children:"packages/extension-api/src/extension-api.d.ts:721"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L713",children:"packages/extension-api/src/extension-api.d.ts:713"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L720",children:"packages/extension-api/src/extension-api.d.ts:720"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L712",children:"packages/extension-api/src/extension-api.d.ts:712"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L709",children:"packages/extension-api/src/extension-api.d.ts:709"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}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 diff --git a/assets/js/b5114993.97da2399.js b/assets/js/b5114993.53b2f21b.js similarity index 87% rename from assets/js/b5114993.97da2399.js rename to assets/js/b5114993.53b2f21b.js index 7b972982b3d..9ce3c860a18 100644 --- a/assets/js/b5114993.97da2399.js +++ b/assets/js/b5114993.53b2f21b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{48444:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var i=n(24246),r=n(71670);const c={},l="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"}},o={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:()=>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 a(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54373],{48444:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>o});var i=n(24246),r=n(71670);const l={},c="Class: Disposable",d={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={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:()=>d,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 d(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 diff --git a/assets/js/b51a9aee.d6e4bf54.js b/assets/js/b51a9aee.6fa241a2.js similarity index 94% rename from assets/js/b51a9aee.d6e4bf54.js rename to assets/js/b51a9aee.6fa241a2.js index eb40423a582..ead616fb211 100644 --- a/assets/js/b51a9aee.d6e4bf54.js +++ b/assets/js/b51a9aee.6fa241a2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[39620],{42154:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4278",children:"packages/extension-api/src/extension-api.d.ts:4278"})})]})}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],{42154:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4278",children:"packages/extension-api/src/extension-api.d.ts:4278"})})]})}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.b28c2713.js b/assets/js/b52d840d.b28c2713.js new file mode 100644 index 00000000000..2489ef56d4f --- /dev/null +++ b/assets/js/b52d840d.b28c2713.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{26317:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3217",children:"packages/extension-api/src/extension-api.d.ts:3217"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3220",children:"packages/extension-api/src/extension-api.d.ts:3220"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3223",children:"packages/extension-api/src/extension-api.d.ts:3223"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3221",children:"packages/extension-api/src/extension-api.d.ts:3221"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3219",children:"packages/extension-api/src/extension-api.d.ts:3219"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3225",children:"packages/extension-api/src/extension-api.d.ts:3225"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3224",children:"packages/extension-api/src/extension-api.d.ts:3224"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3226",children:"packages/extension-api/src/extension-api.d.ts:3226"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3218",children:"packages/extension-api/src/extension-api.d.ts:3218"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3215",children:"packages/extension-api/src/extension-api.d.ts:3215"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3216",children:"packages/extension-api/src/extension-api.d.ts:3216"})})]})}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/b52d840d.bd99fc97.js b/assets/js/b52d840d.bd99fc97.js deleted file mode 100644 index f7b5cf74402..00000000000 --- a/assets/js/b52d840d.bd99fc97.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[35584],{26317:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var c=s(24246),i=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={},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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-volumeinfo",children:"Interface: VolumeInfo"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"createdat",children:"CreatedAt"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"CreatedAt"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3217",children:"packages/extension-api/src/extension-api.d.ts:3217"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"driver",children:"Driver"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Driver"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3220",children:"packages/extension-api/src/extension-api.d.ts:3220"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"labels",children:"Labels"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Labels"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3223",children:"packages/extension-api/src/extension-api.d.ts:3223"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"mountpoint",children:"Mountpoint"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Mountpoint"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3221",children:"packages/extension-api/src/extension-api.d.ts:3221"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"Name"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Name"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3219",children:"packages/extension-api/src/extension-api.d.ts:3219"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"options",children:"Options?"}),"\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:"Options"}),": ",(0,c.jsx)(n.code,{children:"null"})," | ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3225",children:"packages/extension-api/src/extension-api.d.ts:3225"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"scope",children:"Scope"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Scope"}),": ",(0,c.jsx)(n.code,{children:'"global"'})," | ",(0,c.jsx)(n.code,{children:'"local"'})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3224",children:"packages/extension-api/src/extension-api.d.ts:3224"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"status",children:"Status?"}),"\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:"Status"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3222",children:"packages/extension-api/src/extension-api.d.ts:3222"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"usagedata",children:"UsageData?"}),"\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:"UsageData"}),": ",(0,c.jsx)(n.code,{children:"null"})," | ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3226",children:"packages/extension-api/src/extension-api.d.ts:3226"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"containersusage",children:"containersUsage"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"containersUsage"}),": ",(0,c.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3218",children:"packages/extension-api/src/extension-api.d.ts:3218"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3215",children:"packages/extension-api/src/extension-api.d.ts:3215"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"enginename",children:"engineName"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineName"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3216",children:"packages/extension-api/src/extension-api.d.ts:3216"})})]})}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:()=>t,a:()=>o});var c=s(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 t(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/b5b19789.458b75bc.js b/assets/js/b5b19789.458b75bc.js new file mode 100644 index 00000000000..8e366024908 --- /dev/null +++ b/assets/js/b5b19789.458b75bc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{40508:(e,t,n)=>{n.r(t),n.d(t,{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(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaralignright",children:"Variable: StatusBarAlignRight"}),"\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:"StatusBarAlignRight"}),": ",(0,a.jsx)(t.code,{children:'"RIGHT"'})," = ",(0,a.jsx)(t.code,{children:"'RIGHT'"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Aligned to the right 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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1300",children:"packages/extension-api/src/extension-api.d.ts:1300"})})]})}function d(e={}){const{wrapper:t}={...(0,i.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:()=>s});var a=n(27378);const i={},r=a.createContext(i);function s(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(i):e.components||i:s(e.components),a.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b5b19789.e0aa1fe4.js b/assets/js/b5b19789.e0aa1fe4.js deleted file mode 100644 index 6d73d83f840..00000000000 --- a/assets/js/b5b19789.e0aa1fe4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80355],{40508:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1300",children:"packages/extension-api/src/extension-api.d.ts:1300"})})]})}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.4bec9177.js b/assets/js/b5ec5208.df75c50e.js similarity index 87% rename from assets/js/b5ec5208.4bec9177.js rename to assets/js/b5ec5208.df75c50e.js index 791c79f2ac2..fd0d36f7da4 100644 --- a/assets/js/b5ec5208.4bec9177.js +++ b/assets/js/b5ec5208.df75c50e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92514],{45617:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L659",children:"packages/extension-api/src/extension-api.d.ts:659"})})]})}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([[92514],{45617:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L659",children:"packages/extension-api/src/extension-api.d.ts:659"})})]})}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 diff --git a/assets/js/b66ca8cf.7a0e7e86.js b/assets/js/b66ca8cf.98343928.js similarity index 98% rename from assets/js/b66ca8cf.7a0e7e86.js rename to assets/js/b66ca8cf.98343928.js index 7ec3badccba..5543a2625ef 100644 --- a/assets/js/b66ca8cf.7a0e7e86.js +++ b/assets/js/b66ca8cf.98343928.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[42205],{94022:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L746",children:"packages/extension-api/src/extension-api.d.ts:746"})})]})}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],{94022:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L746",children:"packages/extension-api/src/extension-api.d.ts:746"})})]})}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.34aa4ef9.js b/assets/js/b678a236.972e8bf2.js similarity index 96% rename from assets/js/b678a236.34aa4ef9.js rename to assets/js/b678a236.972e8bf2.js index 621d2b11a72..96014bc17f3 100644 --- a/assets/js/b678a236.34aa4ef9.js +++ b/assets/js/b678a236.972e8bf2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37245],{3707:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3353",children:"packages/extension-api/src/extension-api.d.ts:3353"})})]})}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],{3707:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3353",children:"packages/extension-api/src/extension-api.d.ts:3353"})})]})}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.355e4801.js b/assets/js/b6be2912.f7889945.js similarity index 87% rename from assets/js/b6be2912.355e4801.js rename to assets/js/b6be2912.f7889945.js index c0b331d5af6..e75aff904b3 100644 --- a/assets/js/b6be2912.355e4801.js +++ b/assets/js/b6be2912.f7889945.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{62461:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1716",children:"packages/extension-api/src/extension-api.d.ts:1716"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82424],{62461:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1716",children:"packages/extension-api/src/extension-api.d.ts:1716"})})]})}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 diff --git a/assets/js/b6d76a6c.0f153c5f.js b/assets/js/b6d76a6c.4ab1848d.js similarity index 87% rename from assets/js/b6d76a6c.0f153c5f.js rename to assets/js/b6d76a6c.4ab1848d.js index fa7f3f7f0cb..6174326bbd4 100644 --- a/assets/js/b6d76a6c.0f153c5f.js +++ b/assets/js/b6d76a6c.4ab1848d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3667],{83285:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=s(24246),i=s(71670);const a={},r="Function: onDidStateChange()",c={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"}},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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}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:()=>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 c(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],{83285:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L694",children:"packages/extension-api/src/extension-api.d.ts:694"})})]})}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.d253fe63.js b/assets/js/b7bb2d93.e542b49c.js similarity index 83% rename from assets/js/b7bb2d93.d253fe63.js rename to assets/js/b7bb2d93.e542b49c.js index 42b8eb7da9e..1570496e356 100644 --- a/assets/js/b7bb2d93.d253fe63.js +++ b/assets/js/b7bb2d93.e542b49c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16855],{13075:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=o(24246),r=o(71670);const s={},i="Enumeration: ProgressLocation",c={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"}},a={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L856",children:"packages/extension-api/src/extension-api.d.ts:856"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L861",children:"packages/extension-api/src/extension-api.d.ts:861"})})]})}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:()=>c,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 c(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],{13075:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L856",children:"packages/extension-api/src/extension-api.d.ts:856"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L861",children:"packages/extension-api/src/extension-api.d.ts:861"})})]})}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.83dd2e96.js b/assets/js/b8eb0fce.748ddb1f.js similarity index 89% rename from assets/js/b8eb0fce.83dd2e96.js rename to assets/js/b8eb0fce.748ddb1f.js index 9cf221cf776..bca5acf63f1 100644 --- a/assets/js/b8eb0fce.83dd2e96.js +++ b/assets/js/b8eb0fce.748ddb1f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{4061:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L744",children:"packages/extension-api/src/extension-api.d.ts:744"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[69584],{4061:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L744",children:"packages/extension-api/src/extension-api.d.ts:744"})})]})}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/b8ec852b.efd4f384.js b/assets/js/b8ec852b.10bfcbcf.js similarity index 80% rename from assets/js/b8ec852b.efd4f384.js rename to assets/js/b8ec852b.10bfcbcf.js index 8ce312f443e..3ce65bb38b1 100644 --- a/assets/js/b8ec852b.efd4f384.js +++ b/assets/js/b8ec852b.10bfcbcf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{73444:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>l});var o=s(24246),r=s(71670);const t={},c="Interface: ProgressOptions",i={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L871",children:"packages/extension-api/src/extension-api.d.ts:871"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L877",children:"packages/extension-api/src/extension-api.d.ts:877"})})]})}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:()=>i,a:()=>c});var o=s(27378);const r={},t=o.createContext(r);function c(e){const n=o.useContext(t);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(r):e.components||r:c(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63407],{73444:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L885",children:"packages/extension-api/src/extension-api.d.ts:885"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L871",children:"packages/extension-api/src/extension-api.d.ts:871"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L877",children:"packages/extension-api/src/extension-api.d.ts:877"})})]})}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.58ebe5a3.js b/assets/js/b9287eb6.58ebe5a3.js deleted file mode 100644 index ca411de4aae..00000000000 --- a/assets/js/b9287eb6.58ebe5a3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{16913:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>a,toc:()=>d});var c=s(24246),r=s(71670);const t={},i="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,r.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-cpuusage",children:"Interface: CPUUsage"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"percpu_usage",children:"percpu_usage"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"percpu_usage"}),": ",(0,c.jsx)(n.code,{children:"number"}),"[]"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2967",children:"packages/extension-api/src/extension-api.d.ts:2967"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"total_usage",children:"total_usage"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"total_usage"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2969",children:"packages/extension-api/src/extension-api.d.ts:2969"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"usage_in_kernelmode",children:"usage_in_kernelmode"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"usage_in_kernelmode"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2970",children:"packages/extension-api/src/extension-api.d.ts:2970"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"usage_in_usermode",children:"usage_in_usermode"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"usage_in_usermode"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2968",children:"packages/extension-api/src/extension-api.d.ts:2968"})})]})}function u(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:()=>a,a:()=>i});var c=s(27378);const r={},t=c.createContext(r);function i(e){const n=c.useContext(t);return c.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),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9287eb6.926730a4.js b/assets/js/b9287eb6.926730a4.js new file mode 100644 index 00000000000..1383c2f5f45 --- /dev/null +++ b/assets/js/b9287eb6.926730a4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[89251],{16913:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=s(24246),t=s(71670);const i={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2967",children:"packages/extension-api/src/extension-api.d.ts:2967"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2969",children:"packages/extension-api/src/extension-api.d.ts:2969"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2970",children:"packages/extension-api/src/extension-api.d.ts:2970"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2968",children:"packages/extension-api/src/extension-api.d.ts:2968"})})]})}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:()=>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 o(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 diff --git a/assets/js/b9a87183.07d3145f.js b/assets/js/b9a87183.36f7a87b.js similarity index 76% rename from assets/js/b9a87183.07d3145f.js rename to assets/js/b9a87183.36f7a87b.js index ca5785dec4b..2d265a59189 100644 --- a/assets/js/b9a87183.07d3145f.js +++ b/assets/js/b9a87183.36f7a87b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25821],{91182:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=t(24246),r=t(71670);const o={},c="Interface: AuthenticationProviderInformation",a={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3612",children:"packages/extension-api/src/extension-api.d.ts:3612"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3617",children:"packages/extension-api/src/extension-api.d.ts:3617"})})]})}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:()=>a,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 a(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([[25821],{91182:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var i=t(24246),r=t(71670);const o={},a="Interface: AuthenticationProviderInformation",s={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"}},c={},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3612",children:"packages/extension-api/src/extension-api.d.ts:3612"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3617",children:"packages/extension-api/src/extension-api.d.ts:3617"})})]})}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:()=>s,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 s(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.adf1d069.js b/assets/js/bab44fba.d0da83dd.js similarity index 98% rename from assets/js/bab44fba.adf1d069.js rename to assets/js/bab44fba.d0da83dd.js index 60430735ace..987e0a74e22 100644 --- a/assets/js/bab44fba.adf1d069.js +++ b/assets/js/bab44fba.d0da83dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[98170],{51971:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3494",children:"packages/extension-api/src/extension-api.d.ts:3494"})})]})}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],{51971:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3494",children:"packages/extension-api/src/extension-api.d.ts:3494"})})]})}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.209f4204.js b/assets/js/bb6a5560.2444d7c9.js similarity index 95% rename from assets/js/bb6a5560.209f4204.js rename to assets/js/bb6a5560.2444d7c9.js index 95efff483a9..c4a2bc7ce2e 100644 --- a/assets/js/bb6a5560.209f4204.js +++ b/assets/js/bb6a5560.2444d7c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2883],{36:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L687",children:"packages/extension-api/src/extension-api.d.ts:687"})})]})}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],{36:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L687",children:"packages/extension-api/src/extension-api.d.ts:687"})})]})}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.d702d7ff.js b/assets/js/bd45720e.ff57dc39.js similarity index 82% rename from assets/js/bd45720e.d702d7ff.js rename to assets/js/bd45720e.ff57dc39.js index c24c3ef6a02..c6e04566b20 100644 --- a/assets/js/bd45720e.d702d7ff.js +++ b/assets/js/bd45720e.ff57dc39.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13239],{54066:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=t(24246),a=t(71670);const o={},s="Function: navigateToContainer()",c={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"}},r={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4264",children:"packages/extension-api/src/extension-api.d.ts:4264"})})]})}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:()=>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([[13239],{54066:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4264",children:"packages/extension-api/src/extension-api.d.ts:4264"})})]})}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.fafbf591.js b/assets/js/bd65ec7e.2cf74df2.js similarity index 82% rename from assets/js/bd65ec7e.fafbf591.js rename to assets/js/bd65ec7e.2cf74df2.js index 4c5875950b6..a4c9ebd3a26 100644 --- a/assets/js/bd65ec7e.fafbf591.js +++ b/assets/js/bd65ec7e.2cf74df2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{83934:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>r,metadata:()=>i,toc:()=>u});var t=s(24246),c=s(71670);const r={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1926",children:"packages/extension-api/src/extension-api.d.ts:1926"})})]})}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:()=>i,a:()=>o});var t=s(27378);const c={},r=t.createContext(c);function o(e){const n=t.useContext(r);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(c):e.components||c:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41798],{83934:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1926",children:"packages/extension-api/src/extension-api.d.ts:1926"})})]})}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.62d528e6.js b/assets/js/bdb8b81b.cda8a080.js similarity index 84% rename from assets/js/bdb8b81b.62d528e6.js rename to assets/js/bdb8b81b.cda8a080.js index 9f96ad1bfef..21c3f155774 100644 --- a/assets/js/bdb8b81b.62d528e6.js +++ b/assets/js/bdb8b81b.cda8a080.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{20484:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=t(24246),r=t(71670);const i={},c="Interface: StorageStats",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2903",children:"packages/extension-api/src/extension-api.d.ts:2903"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2904",children:"packages/extension-api/src/extension-api.d.ts:2904"})})]})}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:()=>o,a:()=>c});var s=t(27378);const r={},i=s.createContext(r);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(r):e.components||r:c(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57549],{20484:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2901",children:"packages/extension-api/src/extension-api.d.ts:2901"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2902",children:"packages/extension-api/src/extension-api.d.ts:2902"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2903",children:"packages/extension-api/src/extension-api.d.ts:2903"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2904",children:"packages/extension-api/src/extension-api.d.ts:2904"})})]})}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.30817129.js b/assets/js/be228752.30817129.js new file mode 100644 index 00000000000..ba8d739bc0a --- /dev/null +++ b/assets/js/be228752.30817129.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{80699:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4285",children:"packages/extension-api/src/extension-api.d.ts:4285"})})]})}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/be228752.425069d1.js b/assets/js/be228752.425069d1.js deleted file mode 100644 index 2a83e8ab0ac..00000000000 --- a/assets/js/be228752.425069d1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13573],{80699:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4285",children:"packages/extension-api/src/extension-api.d.ts:4285"})})]})}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/bf11c6a2.46fde7c4.js b/assets/js/bf11c6a2.483f1438.js similarity index 81% rename from assets/js/bf11c6a2.46fde7c4.js rename to assets/js/bf11c6a2.483f1438.js index 45055bf9d59..935a565f1ca 100644 --- a/assets/js/bf11c6a2.46fde7c4.js +++ b/assets/js/bf11c6a2.483f1438.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75290],{78608:(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: 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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L721",children:"packages/extension-api/src/extension-api.d.ts:721"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L720",children:"packages/extension-api/src/extension-api.d.ts:720"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}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([[75290],{78608:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L721",children:"packages/extension-api/src/extension-api.d.ts:721"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L720",children:"packages/extension-api/src/extension-api.d.ts:720"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L719",children:"packages/extension-api/src/extension-api.d.ts:719"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L717",children:"packages/extension-api/src/extension-api.d.ts:717"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L718",children:"packages/extension-api/src/extension-api.d.ts:718"})})]})}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.a7e26a4c.js b/assets/js/c09ab32f.67e99045.js similarity index 97% rename from assets/js/c09ab32f.a7e26a4c.js rename to assets/js/c09ab32f.67e99045.js index 19e10b533b3..6da759e58fc 100644 --- a/assets/js/c09ab32f.a7e26a4c.js +++ b/assets/js/c09ab32f.67e99045.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[29112],{18740:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1296",children:"packages/extension-api/src/extension-api.d.ts:1296"})})]})}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],{18740:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1296",children:"packages/extension-api/src/extension-api.d.ts:1296"})})]})}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.f9340c93.js b/assets/js/c104141c.4ac3512e.js similarity index 95% rename from assets/js/c104141c.f9340c93.js rename to assets/js/c104141c.4ac3512e.js index bf0937ef85d..7d2c0b8c7d5 100644 --- a/assets/js/c104141c.f9340c93.js +++ b/assets/js/c104141c.4ac3512e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[26348],{50341:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})})]})}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],{50341:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L509",children:"packages/extension-api/src/extension-api.d.ts:509"})})]})}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.abc1d425.js b/assets/js/c1584a80.3d65a66d.js similarity index 80% rename from assets/js/c1584a80.abc1d425.js rename to assets/js/c1584a80.3d65a66d.js index 48446802c83..a928a2d4e94 100644 --- a/assets/js/c1584a80.abc1d425.js +++ b/assets/js/c1584a80.3d65a66d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{31917:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var s=r(24246),t=r(71670);const c={},i="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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L333",children:"packages/extension-api/src/extension-api.d.ts:333"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L331",children:"packages/extension-api/src/extension-api.d.ts:331"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L335",children:"packages/extension-api/src/extension-api.d.ts:335"})})]})}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:()=>i});var s=r(27378);const t={},c=s.createContext(t);function i(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(t):e.components||t:i(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19537],{31917:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var s=r(24246),t=r(71670);const i={},o="Interface: Logger",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L333",children:"packages/extension-api/src/extension-api.d.ts:333"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L331",children:"packages/extension-api/src/extension-api.d.ts:331"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L335",children:"packages/extension-api/src/extension-api.d.ts:335"})})]})}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:()=>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/c1ca9e21.00c06673.js b/assets/js/c1ca9e21.00c06673.js deleted file mode 100644 index c02f145cffd..00000000000 --- a/assets/js/c1ca9e21.00c06673.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{17487:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1940",children:"packages/extension-api/src/extension-api.d.ts:1940"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1939",children:"packages/extension-api/src/extension-api.d.ts:1939"})})]})}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/c1ca9e21.59d3195c.js b/assets/js/c1ca9e21.59d3195c.js new file mode 100644 index 00000000000..d308954b540 --- /dev/null +++ b/assets/js/c1ca9e21.59d3195c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[17285],{17487:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1940",children:"packages/extension-api/src/extension-api.d.ts:1940"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1939",children:"packages/extension-api/src/extension-api.d.ts:1939"})})]})}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/c239db97.0e1e0ed2.js b/assets/js/c239db97.4bb4d41b.js similarity index 84% rename from assets/js/c239db97.0e1e0ed2.js rename to assets/js/c239db97.4bb4d41b.js index f7460d2d814..f2c6c2dd6b2 100644 --- a/assets/js/c239db97.0e1e0ed2.js +++ b/assets/js/c239db97.4bb4d41b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{24342:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var s=i(24246),t=i(71670);const a={},c="Function: saveImage()",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})})]})}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:()=>r,a:()=>c});var s=i(27378);const t={},a=s.createContext(t);function c(e){const n=s.useContext(a);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(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[62789],{24342:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3383",children:"packages/extension-api/src/extension-api.d.ts:3383"})})]})}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.472e0103.js b/assets/js/c25913f3.f0eb2792.js similarity index 88% rename from assets/js/c25913f3.472e0103.js rename to assets/js/c25913f3.f0eb2792.js index a42e593ee55..411c275ea33 100644 --- a/assets/js/c25913f3.472e0103.js +++ b/assets/js/c25913f3.f0eb2792.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{85626:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L938",children:"packages/extension-api/src/extension-api.d.ts:938"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L945",children:"packages/extension-api/src/extension-api.d.ts:945"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16311],{85626:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L938",children:"packages/extension-api/src/extension-api.d.ts:938"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L945",children:"packages/extension-api/src/extension-api.d.ts:945"})})]})}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 diff --git a/assets/js/c2865a15.ae6d8608.js b/assets/js/c2865a15.0d4357bf.js similarity index 97% rename from assets/js/c2865a15.ae6d8608.js rename to assets/js/c2865a15.0d4357bf.js index cda83b154a8..e7b379dc41b 100644 --- a/assets/js/c2865a15.ae6d8608.js +++ b/assets/js/c2865a15.0d4357bf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[93401],{74193:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2203",children:"packages/extension-api/src/extension-api.d.ts:2203"})})]})}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],{74193:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2203",children:"packages/extension-api/src/extension-api.d.ts:2203"})})]})}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.fef4c56b.js b/assets/js/c358ebbc.729775f2.js similarity index 93% rename from assets/js/c358ebbc.fef4c56b.js rename to assets/js/c358ebbc.729775f2.js index 75c4a54ee63..d26bf853225 100644 --- a/assets/js/c358ebbc.fef4c56b.js +++ b/assets/js/c358ebbc.729775f2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[27910],{98358:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>l,frontMatter:()=>t,metadata:()=>c,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3673",children:"packages/extension-api/src/extension-api.d.ts:3673"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3696",children:"packages/extension-api/src/extension-api.d.ts:3696"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3681",children:"packages/extension-api/src/extension-api.d.ts:3681"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3706",children:"packages/extension-api/src/extension-api.d.ts:3706"})})]})}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],{98358:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3673",children:"packages/extension-api/src/extension-api.d.ts:3673"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3696",children:"packages/extension-api/src/extension-api.d.ts:3696"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3681",children:"packages/extension-api/src/extension-api.d.ts:3681"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3706",children:"packages/extension-api/src/extension-api.d.ts:3706"})})]})}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.4c5d097d.js b/assets/js/c544b2d7.5c965f19.js similarity index 88% rename from assets/js/c544b2d7.4c5d097d.js rename to assets/js/c544b2d7.5c965f19.js index 47b030d0981..0be072d78ea 100644 --- a/assets/js/c544b2d7.4c5d097d.js +++ b/assets/js/c544b2d7.5c965f19.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{72299:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75689],{72299:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3161",children:"packages/extension-api/src/extension-api.d.ts:3161"})})]})}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 diff --git a/assets/js/c7cac05f.71963467.js b/assets/js/c7cac05f.f438836d.js similarity index 82% rename from assets/js/c7cac05f.71963467.js rename to assets/js/c7cac05f.f438836d.js index 81ab61b54d2..2b8267b4bc2 100644 --- a/assets/js/c7cac05f.71963467.js +++ b/assets/js/c7cac05f.f438836d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{66013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var s=i(24246),o=i(71670);const t={},c="Interface: OpenDialogOptions",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1632",children:"packages/extension-api/src/extension-api.d.ts:1632"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1648",children:"packages/extension-api/src/extension-api.d.ts:1648"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1637",children:"packages/extension-api/src/extension-api.d.ts:1637"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1643",children:"packages/extension-api/src/extension-api.d.ts:1643"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1656",children:"packages/extension-api/src/extension-api.d.ts:1656"})})]})}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:()=>r,a:()=>c});var s=i(27378);const o={},t=s.createContext(o);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(o):e.components||o:c(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73867],{66013:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>d});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={},d=[{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 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,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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1632",children:"packages/extension-api/src/extension-api.d.ts:1632"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1648",children:"packages/extension-api/src/extension-api.d.ts:1648"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1637",children:"packages/extension-api/src/extension-api.d.ts:1637"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1643",children:"packages/extension-api/src/extension-api.d.ts:1643"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1656",children:"packages/extension-api/src/extension-api.d.ts:1656"})})]})}function p(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(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.86332906.js b/assets/js/c813bd67.ac6defd3.js similarity index 75% rename from assets/js/c813bd67.86332906.js rename to assets/js/c813bd67.ac6defd3.js index 85585f5af8e..9cb8db1f443 100644 --- a/assets/js/c813bd67.86332906.js +++ b/assets/js/c813bd67.ac6defd3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{9762:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var i=s(24246),c=s(71670);const r={},t="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"}},a={},d=[{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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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:"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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}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,s)=>{s.d(n,{Z:()=>o,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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82163],{9762:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2075",children:"packages/extension-api/src/extension-api.d.ts:2075"})})]})}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.67b7f3c1.js b/assets/js/ca1234c1.df5146c3.js similarity index 89% rename from assets/js/ca1234c1.67b7f3c1.js rename to assets/js/ca1234c1.df5146c3.js index 4b7e175b3cd..e2947bc136c 100644 --- a/assets/js/ca1234c1.67b7f3c1.js +++ b/assets/js/ca1234c1.df5146c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[77401],{23783:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4077",children:"packages/extension-api/src/extension-api.d.ts:4077"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4065",children:"packages/extension-api/src/extension-api.d.ts:4065"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})})]})}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],{23783:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4077",children:"packages/extension-api/src/extension-api.d.ts:4077"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4065",children:"packages/extension-api/src/extension-api.d.ts:4065"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4071",children:"packages/extension-api/src/extension-api.d.ts:4071"})})]})}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.4e4c0bbc.js b/assets/js/ca165b51.faa1641e.js similarity index 93% rename from assets/js/ca165b51.4e4c0bbc.js rename to assets/js/ca165b51.faa1641e.js index 5470fe979dc..3dc57782754 100644 --- a/assets/js/ca165b51.4e4c0bbc.js +++ b/assets/js/ca165b51.faa1641e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68059],{89508:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L681",children:"packages/extension-api/src/extension-api.d.ts:681"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L682",children:"packages/extension-api/src/extension-api.d.ts:682"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L683",children:"packages/extension-api/src/extension-api.d.ts:683"})})]})}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],{89508:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L681",children:"packages/extension-api/src/extension-api.d.ts:681"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L682",children:"packages/extension-api/src/extension-api.d.ts:682"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L683",children:"packages/extension-api/src/extension-api.d.ts:683"})})]})}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.b70b3e24.js b/assets/js/caddb1c0.8db12d43.js similarity index 88% rename from assets/js/caddb1c0.b70b3e24.js rename to assets/js/caddb1c0.8db12d43.js index c7937f67777..2167b7c70fe 100644 --- a/assets/js/caddb1c0.b70b3e24.js +++ b/assets/js/caddb1c0.8db12d43.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{99950:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>t,toc:()=>l});var s=r(24246),c=r(71670);const i={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L345",children:"packages/extension-api/src/extension-api.d.ts:345"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L346",children:"packages/extension-api/src/extension-api.d.ts:346"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L343",children:"packages/extension-api/src/extension-api.d.ts:343"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L344",children:"packages/extension-api/src/extension-api.d.ts:344"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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 c={},i=s.createContext(c);function o(e){const n=s.useContext(i);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(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[96987],{99950:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L345",children:"packages/extension-api/src/extension-api.d.ts:345"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L346",children:"packages/extension-api/src/extension-api.d.ts:346"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L343",children:"packages/extension-api/src/extension-api.d.ts:343"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L344",children:"packages/extension-api/src/extension-api.d.ts:344"})})]})}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.e1639572.js b/assets/js/cb0f21df.0952ec6b.js similarity index 90% rename from assets/js/cb0f21df.e1639572.js rename to assets/js/cb0f21df.0952ec6b.js index 38980073b92..150832f82ca 100644 --- a/assets/js/cb0f21df.e1639572.js +++ b/assets/js/cb0f21df.0952ec6b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6098],{14202:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L635",children:"packages/extension-api/src/extension-api.d.ts:635"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L634",children:"packages/extension-api/src/extension-api.d.ts:634"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})})]})}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],{14202:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L635",children:"packages/extension-api/src/extension-api.d.ts:635"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L634",children:"packages/extension-api/src/extension-api.d.ts:634"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L636",children:"packages/extension-api/src/extension-api.d.ts:636"})})]})}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.6a70a927.js b/assets/js/cc6d9416.bbee2bad.js similarity index 80% rename from assets/js/cc6d9416.6a70a927.js rename to assets/js/cc6d9416.bbee2bad.js index 7bbc250fd83..0e330b93702 100644 --- a/assets/js/cc6d9416.6a70a927.js +++ b/assets/js/cc6d9416.bbee2bad.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[71874],{2958:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})})]})}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([[71874],{2958:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2179",children:"packages/extension-api/src/extension-api.d.ts:2179"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2177",children:"packages/extension-api/src/extension-api.d.ts:2177"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2178",children:"packages/extension-api/src/extension-api.d.ts:2178"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2176",children:"packages/extension-api/src/extension-api.d.ts:2176"})})]})}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 diff --git a/assets/js/cc922df3.fcd8f5e4.js b/assets/js/cc922df3.12abe3e4.js similarity index 88% rename from assets/js/cc922df3.fcd8f5e4.js rename to assets/js/cc922df3.12abe3e4.js index 896ed4b3441..e05a8233279 100644 --- a/assets/js/cc922df3.fcd8f5e4.js +++ b/assets/js/cc922df3.12abe3e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[53273],{71270:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var t=i(24246),s=i(71670);const o={},c="Interface: AuthenticationGetSessionOptions",r={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3577",children:"packages/extension-api/src/extension-api.d.ts:3577"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3566",children:"packages/extension-api/src/extension-api.d.ts:3566"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3590",children:"packages/extension-api/src/extension-api.d.ts:3590"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3602",children:"packages/extension-api/src/extension-api.d.ts:3602"})})]})}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:()=>r,a:()=>c});var t=i(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 r(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([[53273],{71270:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3577",children:"packages/extension-api/src/extension-api.d.ts:3577"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3566",children:"packages/extension-api/src/extension-api.d.ts:3566"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3590",children:"packages/extension-api/src/extension-api.d.ts:3590"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3602",children:"packages/extension-api/src/extension-api.d.ts:3602"})})]})}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.185bb5af.js b/assets/js/cdf64ea9.bc8c623a.js similarity index 86% rename from assets/js/cdf64ea9.185bb5af.js rename to assets/js/cdf64ea9.bc8c623a.js index 45534e37265..340ac6f9ffe 100644 --- a/assets/js/cdf64ea9.185bb5af.js +++ b/assets/js/cdf64ea9.bc8c623a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{44337:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=s(24246),c=s(71670);const i={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3927",children:"packages/extension-api/src/extension-api.d.ts:3927"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3912",children:"packages/extension-api/src/extension-api.d.ts:3912"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3907",children:"packages/extension-api/src/extension-api.d.ts:3907"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3932",children:"packages/extension-api/src/extension-api.d.ts:3932"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3902",children:"packages/extension-api/src/extension-api.d.ts:3902"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3922",children:"packages/extension-api/src/extension-api.d.ts:3922"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3917",children:"packages/extension-api/src/extension-api.d.ts:3917"})})]})}function h(e={}){const{wrapper:n}={...(0,c.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 c={},i=r.createContext(c);function d(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(c):e.components||c:d(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[90681],{44337:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>l});var r=s(24246),i=s(71670);const d={},c="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3927",children:"packages/extension-api/src/extension-api.d.ts:3927"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3912",children:"packages/extension-api/src/extension-api.d.ts:3912"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3907",children:"packages/extension-api/src/extension-api.d.ts:3907"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3932",children:"packages/extension-api/src/extension-api.d.ts:3932"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3902",children:"packages/extension-api/src/extension-api.d.ts:3902"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3922",children:"packages/extension-api/src/extension-api.d.ts:3922"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3917",children:"packages/extension-api/src/extension-api.d.ts:3917"})})]})}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={},d=r.createContext(i);function c(e){const n=r.useContext(d);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(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfdfe126.9e838136.js b/assets/js/cfdfe126.4f8f791f.js similarity index 96% rename from assets/js/cfdfe126.9e838136.js rename to assets/js/cfdfe126.4f8f791f.js index 92bcab2944e..5aab5a833f5 100644 --- a/assets/js/cfdfe126.9e838136.js +++ b/assets/js/cfdfe126.4f8f791f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64471],{86579:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1706",children:"packages/extension-api/src/extension-api.d.ts:1706"})})]})}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],{86579:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1706",children:"packages/extension-api/src/extension-api.d.ts:1706"})})]})}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.3f82a0be.js b/assets/js/d103759a.99d755a6.js similarity index 98% rename from assets/js/d103759a.3f82a0be.js rename to assets/js/d103759a.99d755a6.js index 04293d644e1..09dcff83961 100644 --- a/assets/js/d103759a.3f82a0be.js +++ b/assets/js/d103759a.99d755a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65191],{70093:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1805",children:"packages/extension-api/src/extension-api.d.ts:1805"})})]})}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],{70093:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1805",children:"packages/extension-api/src/extension-api.d.ts:1805"})})]})}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.15291a6f.js b/assets/js/d1163e47.531439b5.js similarity index 52% rename from assets/js/d1163e47.15291a6f.js rename to assets/js/d1163e47.531439b5.js index 7f1645b3ffd..8f4a6fb145c 100644 --- a/assets/js/d1163e47.15291a6f.js +++ b/assets/js/d1163e47.531439b5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[59860],{50575:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4233",children:"packages/extension-api/src/extension-api.d.ts:4233"})})]})}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],{50575:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4233",children:"packages/extension-api/src/extension-api.d.ts:4233"})})]})}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.ef24eb8d.js b/assets/js/d46ef83d.140b5374.js similarity index 84% rename from assets/js/d46ef83d.ef24eb8d.js rename to assets/js/d46ef83d.140b5374.js index 402d233c60c..7decd05380e 100644 --- a/assets/js/d46ef83d.ef24eb8d.js +++ b/assets/js/d46ef83d.140b5374.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{19909:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2207",children:"packages/extension-api/src/extension-api.d.ts:2207"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[10579],{19909:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2207",children:"packages/extension-api/src/extension-api.d.ts:2207"})})]})}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 diff --git a/assets/js/d496897e.10458b8e.js b/assets/js/d496897e.10458b8e.js deleted file mode 100644 index 16acb3f0d32..00000000000 --- a/assets/js/d496897e.10458b8e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{87394:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var c=t(24246),s=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,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-createpod",children:"Function: createPod()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"createPod"}),"(",(0,c.jsx)(n.code,{children:"podOptions"}),"): ",(0,c.jsx)(n.code,{children:"Promise"}),"<",(0,c.jsx)(n.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"podOptions"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/PodCreateOptions",children:(0,c.jsx)(n.code,{children:"PodCreateOptions"})})]}),"\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.code,{children:"object"}),">"]}),"\n",(0,c.jsx)(n.h3,{id:"id",children:"Id"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Id"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h3,{id:"engineid",children:"engineId"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"engineId"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3493",children:"packages/extension-api/src/extension-api.d.ts:3493"})})]})}function p(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,t)=>{t.d(n,{Z:()=>o,a:()=>i});var c=t(27378);const s={},r=c.createContext(s);function i(e){const n=c.useContext(r);return c.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),c.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d496897e.14aa56e1.js b/assets/js/d496897e.14aa56e1.js new file mode 100644 index 00000000000..11e26ca142d --- /dev/null +++ b/assets/js/d496897e.14aa56e1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[25211],{87394:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3493",children:"packages/extension-api/src/extension-api.d.ts:3493"})})]})}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.869edc29.js b/assets/js/d66cbd9e.ef4ff3c0.js similarity index 79% rename from assets/js/d66cbd9e.869edc29.js rename to assets/js/d66cbd9e.ef4ff3c0.js index 42b6fc45268..8a1acd7b6ba 100644 --- a/assets/js/d66cbd9e.869edc29.js +++ b/assets/js/d66cbd9e.ef4ff3c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[20044],{37558:(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: Port",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2133",children:"packages/extension-api/src/extension-api.d.ts:2133"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2135",children:"packages/extension-api/src/extension-api.d.ts:2135"})})]})}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([[20044],{37558:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2132",children:"packages/extension-api/src/extension-api.d.ts:2132"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2133",children:"packages/extension-api/src/extension-api.d.ts:2133"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2134",children:"packages/extension-api/src/extension-api.d.ts:2134"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2135",children:"packages/extension-api/src/extension-api.d.ts:2135"})})]})}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.f14eb19a.js b/assets/js/d739767a.d10e8334.js similarity index 96% rename from assets/js/d739767a.f14eb19a.js rename to assets/js/d739767a.d10e8334.js index 4b074eb785f..16b45c549d7 100644 --- a/assets/js/d739767a.f14eb19a.js +++ b/assets/js/d739767a.d10e8334.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64389],{12904:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3815",children:"packages/extension-api/src/extension-api.d.ts:3815"})})]})}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],{12904:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3815",children:"packages/extension-api/src/extension-api.d.ts:3815"})})]})}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.4aa59793.js b/assets/js/d83f208d.4aa59793.js new file mode 100644 index 00000000000..eb3aa805eb1 --- /dev/null +++ b/assets/js/d83f208d.4aa59793.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{56993:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>l});var i=s(24246),r=s(71670);const c={},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,r.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3872",children:"packages/extension-api/src/extension-api.d.ts:3872"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3867",children:"packages/extension-api/src/extension-api.d.ts:3867"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3857",children:"packages/extension-api/src/extension-api.d.ts:3857"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3852",children:"packages/extension-api/src/extension-api.d.ts:3852"})})]})}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:()=>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/d83f208d.58487b73.js b/assets/js/d83f208d.58487b73.js deleted file mode 100644 index fd49c561a84..00000000000 --- a/assets/js/d83f208d.58487b73.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[13317],{56993:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>a});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-runoptions",children:"Interface: RunOptions"}),"\n",(0,c.jsx)(n.p,{children:"Options for running a command."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"cwd",children:"cwd?"}),"\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:"cwd"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"custom directory"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3862",children:"packages/extension-api/src/extension-api.d.ts:3862"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"encoding",children:"encoding?"}),"\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:"encoding"}),": ",(0,c.jsx)(n.code,{children:"BufferEncoding"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"The encoding to use. Default utf8"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3872",children:"packages/extension-api/src/extension-api.d.ts:3872"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Environment variables to set for the command."}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3847",children:"packages/extension-api/src/extension-api.d.ts:3847"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"isadmin",children:"isAdmin?"}),"\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:"isAdmin"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"admin privileges required"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3867",children:"packages/extension-api/src/extension-api.d.ts:3867"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"logger",children:"logger?"}),"\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:"logger"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Logger",children:(0,c.jsx)(n.code,{children:"Logger"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"A logger used to track execution events."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3857",children:"packages/extension-api/src/extension-api.d.ts:3857"})}),"\n",(0,c.jsx)(n.hr,{}),"\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.code,{children:"optional"})," ",(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:"A cancellation token used to request cancellation."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3852",children:"packages/extension-api/src/extension-api.d.ts:3852"})})]})}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:()=>t,a:()=>o});var c=s(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 t(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/d9407a00.7782c89c.js b/assets/js/d9407a00.7782c89c.js new file mode 100644 index 00000000000..c64786938c7 --- /dev/null +++ b/assets/js/d9407a00.7782c89c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{58836:(e,n,o)=>{o.r(n),o.d(n,{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(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-shownotification",children:"Function: showNotification()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"showNotification"}),"(",(0,i.jsx)(n.code,{children:"options"}),"): ",(0,i.jsx)(n.a,{href:"/api/classes/Disposable",children:(0,i.jsx)(n.code,{children:"Disposable"})})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Show notification on different area of Podman Desktop based on its options (Dashboard, bell icon list, OS notification)"}),"\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/NotificationOptions",children:(0,i.jsx)(n.code,{children:"NotificationOptions"})})]}),"\n",(0,i.jsx)(n.p,{children:"define how the notification must be created."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1796",children:"packages/extension-api/src/extension-api.d.ts:1796"})})]})}function l(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>a,a:()=>c});var i=o(27378);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);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(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d9407a00.fe13c06b.js b/assets/js/d9407a00.fe13c06b.js deleted file mode 100644 index ee3e2fd48b7..00000000000 --- a/assets/js/d9407a00.fe13c06b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[16728],{58836:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1796",children:"packages/extension-api/src/extension-api.d.ts:1796"})})]})}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.23fc6a70.js b/assets/js/d9673b17.ea79bf90.js similarity index 85% rename from assets/js/d9673b17.23fc6a70.js rename to assets/js/d9673b17.ea79bf90.js index 10672ebd642..7621c430741 100644 --- a/assets/js/d9673b17.23fc6a70.js +++ b/assets/js/d9673b17.ea79bf90.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{47262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>l});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={},l=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1274",children:"packages/extension-api/src/extension-api.d.ts:1274"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1290",children:"packages/extension-api/src/extension-api.d.ts:1290"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1286",children:"packages/extension-api/src/extension-api.d.ts:1286"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1278",children:"packages/extension-api/src/extension-api.d.ts:1278"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1270",children:"packages/extension-api/src/extension-api.d.ts:1270"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1282",children:"packages/extension-api/src/extension-api.d.ts:1282"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[58673],{47262:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,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"}},d={},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 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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1274",children:"packages/extension-api/src/extension-api.d.ts:1274"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1290",children:"packages/extension-api/src/extension-api.d.ts:1290"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1286",children:"packages/extension-api/src/extension-api.d.ts:1286"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1278",children:"packages/extension-api/src/extension-api.d.ts:1278"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1270",children:"packages/extension-api/src/extension-api.d.ts:1270"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1282",children:"packages/extension-api/src/extension-api.d.ts:1282"})})]})}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 diff --git a/assets/js/d9b4ee1e.1ad2c453.js b/assets/js/d9b4ee1e.c05a8349.js similarity index 95% rename from assets/js/d9b4ee1e.1ad2c453.js rename to assets/js/d9b4ee1e.c05a8349.js index 91ba74fe803..e2377d9731e 100644 --- a/assets/js/d9b4ee1e.1ad2c453.js +++ b/assets/js/d9b4ee1e.c05a8349.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[19841],{46693:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1943",children:"packages/extension-api/src/extension-api.d.ts:1943"})})]})}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],{46693:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1943",children:"packages/extension-api/src/extension-api.d.ts:1943"})})]})}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 diff --git a/assets/js/db22fd17.cd7162f5.js b/assets/js/db22fd17.2b4620c9.js similarity index 75% rename from assets/js/db22fd17.cd7162f5.js rename to assets/js/db22fd17.2b4620c9.js index 56043a88f3e..bb7775964ee 100644 --- a/assets/js/db22fd17.cd7162f5.js +++ b/assets/js/db22fd17.2b4620c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[43474],{4088:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var n=o(24246),s=o(71670);const i={},a="Type alias: CliToolState",c={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"}},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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4151",children:"packages/extension-api/src/extension-api.d.ts:4151"})})]})}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:()=>c,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 c(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],{4088:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4151",children:"packages/extension-api/src/extension-api.d.ts:4151"})})]})}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.c5f0c946.js b/assets/js/dc23cd40.899a0353.js similarity index 86% rename from assets/js/dc23cd40.c5f0c946.js rename to assets/js/dc23cd40.899a0353.js index 31a1ada08cb..bbf0dc2ec20 100644 --- a/assets/js/dc23cd40.c5f0c946.js +++ b/assets/js/dc23cd40.899a0353.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[99124],{8051:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L378",children:"packages/extension-api/src/extension-api.d.ts:378"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L376",children:"packages/extension-api/src/extension-api.d.ts:376"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L377",children:"packages/extension-api/src/extension-api.d.ts:377"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L380",children:"packages/extension-api/src/extension-api.d.ts:380"})})]})}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],{8051:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L378",children:"packages/extension-api/src/extension-api.d.ts:378"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L376",children:"packages/extension-api/src/extension-api.d.ts:376"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L377",children:"packages/extension-api/src/extension-api.d.ts:377"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L380",children:"packages/extension-api/src/extension-api.d.ts:380"})})]})}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.4d3790f4.js b/assets/js/dec87402.e1a2e945.js similarity index 82% rename from assets/js/dec87402.4d3790f4.js rename to assets/js/dec87402.e1a2e945.js index 957e1ce6792..32e8fa77b3a 100644 --- a/assets/js/dec87402.4d3790f4.js +++ b/assets/js/dec87402.e1a2e945.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{70887:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>g,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=s(24246),i=s(71670);const r={},c="Function: tagImage()",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}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:()=>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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[1837],{70887:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3412",children:"packages/extension-api/src/extension-api.d.ts:3412"})})]})}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 diff --git a/assets/js/deccabf3.877bf67b.js b/assets/js/deccabf3.072c7e95.js similarity index 91% rename from assets/js/deccabf3.877bf67b.js rename to assets/js/deccabf3.072c7e95.js index d15c19a7339..02b9e04c7cc 100644 --- a/assets/js/deccabf3.877bf67b.js +++ b/assets/js/deccabf3.072c7e95.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[18880],{18654:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L928",children:"packages/extension-api/src/extension-api.d.ts:928"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L926",children:"packages/extension-api/src/extension-api.d.ts:926"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})})]})}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],{18654:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L928",children:"packages/extension-api/src/extension-api.d.ts:928"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L926",children:"packages/extension-api/src/extension-api.d.ts:926"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L927",children:"packages/extension-api/src/extension-api.d.ts:927"})})]})}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.b1dd55e6.js b/assets/js/df2a6e58.7c8a693e.js similarity index 98% rename from assets/js/df2a6e58.b1dd55e6.js rename to assets/js/df2a6e58.7c8a693e.js index 875f2ccf24c..b80adcff29b 100644 --- a/assets/js/df2a6e58.b1dd55e6.js +++ b/assets/js/df2a6e58.7c8a693e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[37683],{39406:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3480",children:"packages/extension-api/src/extension-api.d.ts:3480"})})]})}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],{39406:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3480",children:"packages/extension-api/src/extension-api.d.ts:3480"})})]})}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.ddfff0cb.js b/assets/js/df4d464e.21b8f568.js similarity index 77% rename from assets/js/df4d464e.ddfff0cb.js rename to assets/js/df4d464e.21b8f568.js index 1a5559a5f5c..bf3b742096f 100644 --- a/assets/js/df4d464e.ddfff0cb.js +++ b/assets/js/df4d464e.21b8f568.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{56227:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1918",children:"packages/extension-api/src/extension-api.d.ts:1918"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[82409],{56227:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1918",children:"packages/extension-api/src/extension-api.d.ts:1918"})})]})}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 diff --git a/assets/js/e064f6d4.28a96f17.js b/assets/js/e064f6d4.e5e606c4.js similarity index 92% rename from assets/js/e064f6d4.28a96f17.js rename to assets/js/e064f6d4.e5e606c4.js index 5d502931dbe..f0baee16c89 100644 --- a/assets/js/e064f6d4.28a96f17.js +++ b/assets/js/e064f6d4.e5e606c4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[2866],{52262:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>l,toc:()=>t});var i=s(24246),d=s(71670);const c={},r="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2388",children:"packages/extension-api/src/extension-api.d.ts:2388"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2362",children:"packages/extension-api/src/extension-api.d.ts:2362"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2407",children:"packages/extension-api/src/extension-api.d.ts:2407"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2360",children:"packages/extension-api/src/extension-api.d.ts:2360"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2384",children:"packages/extension-api/src/extension-api.d.ts:2384"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2391",children:"packages/extension-api/src/extension-api.d.ts:2391"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2390",children:"packages/extension-api/src/extension-api.d.ts:2390"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2379",children:"packages/extension-api/src/extension-api.d.ts:2379"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2380",children:"packages/extension-api/src/extension-api.d.ts:2380"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2359",children:"packages/extension-api/src/extension-api.d.ts:2359"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2386",children:"packages/extension-api/src/extension-api.d.ts:2386"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2427",children:"packages/extension-api/src/extension-api.d.ts:2427"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2361",children:"packages/extension-api/src/extension-api.d.ts:2361"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2387",children:"packages/extension-api/src/extension-api.d.ts:2387"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2378",children:"packages/extension-api/src/extension-api.d.ts:2378"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2383",children:"packages/extension-api/src/extension-api.d.ts:2383"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2363",children:"packages/extension-api/src/extension-api.d.ts:2363"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2358",children:"packages/extension-api/src/extension-api.d.ts:2358"})})]})}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:()=>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([[2866],{52262:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2388",children:"packages/extension-api/src/extension-api.d.ts:2388"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2362",children:"packages/extension-api/src/extension-api.d.ts:2362"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2407",children:"packages/extension-api/src/extension-api.d.ts:2407"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2360",children:"packages/extension-api/src/extension-api.d.ts:2360"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2384",children:"packages/extension-api/src/extension-api.d.ts:2384"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2389",children:"packages/extension-api/src/extension-api.d.ts:2389"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2391",children:"packages/extension-api/src/extension-api.d.ts:2391"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2390",children:"packages/extension-api/src/extension-api.d.ts:2390"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2379",children:"packages/extension-api/src/extension-api.d.ts:2379"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2380",children:"packages/extension-api/src/extension-api.d.ts:2380"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2359",children:"packages/extension-api/src/extension-api.d.ts:2359"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2377",children:"packages/extension-api/src/extension-api.d.ts:2377"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2381",children:"packages/extension-api/src/extension-api.d.ts:2381"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2386",children:"packages/extension-api/src/extension-api.d.ts:2386"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2399",children:"packages/extension-api/src/extension-api.d.ts:2399"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2382",children:"packages/extension-api/src/extension-api.d.ts:2382"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2427",children:"packages/extension-api/src/extension-api.d.ts:2427"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2361",children:"packages/extension-api/src/extension-api.d.ts:2361"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2385",children:"packages/extension-api/src/extension-api.d.ts:2385"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2387",children:"packages/extension-api/src/extension-api.d.ts:2387"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2378",children:"packages/extension-api/src/extension-api.d.ts:2378"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2383",children:"packages/extension-api/src/extension-api.d.ts:2383"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2363",children:"packages/extension-api/src/extension-api.d.ts:2363"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2357",children:"packages/extension-api/src/extension-api.d.ts:2357"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2358",children:"packages/extension-api/src/extension-api.d.ts:2358"})})]})}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.41d4ed17.js b/assets/js/e1a2ab10.5a25a3a0.js similarity index 96% rename from assets/js/e1a2ab10.41d4ed17.js rename to assets/js/e1a2ab10.5a25a3a0.js index e46d10c2eb8..1a0fe7c79a4 100644 --- a/assets/js/e1a2ab10.41d4ed17.js +++ b/assets/js/e1a2ab10.5a25a3a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70225],{99919:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L492",children:"packages/extension-api/src/extension-api.d.ts:492"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})})]})}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],{99919:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L492",children:"packages/extension-api/src/extension-api.d.ts:492"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L490",children:"packages/extension-api/src/extension-api.d.ts:490"})})]})}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.75e71d6d.js b/assets/js/e1c8d71f.c1177430.js similarity index 97% rename from assets/js/e1c8d71f.75e71d6d.js rename to assets/js/e1c8d71f.c1177430.js index 44f401a54e3..227115cd229 100644 --- a/assets/js/e1c8d71f.75e71d6d.js +++ b/assets/js/e1c8d71f.c1177430.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[34884],{16061:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1264",children:"packages/extension-api/src/extension-api.d.ts:1264"})})]})}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],{16061:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1264",children:"packages/extension-api/src/extension-api.d.ts:1264"})})]})}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.b69ad712.js b/assets/js/e35d7c3e.13bc457b.js similarity index 69% rename from assets/js/e35d7c3e.b69ad712.js rename to assets/js/e35d7c3e.13bc457b.js index e4942511da3..8471a9803f3 100644 --- a/assets/js/e35d7c3e.b69ad712.js +++ b/assets/js/e35d7c3e.13bc457b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{20266:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(24246),s=r(71670);const o={},c="Interface: NetworkCreateResult",i={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3169",children:"packages/extension-api/src/extension-api.d.ts:3169"})})]})}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:()=>i,a:()=>c});var n=r(27378);const s={},o=n.createContext(s);function c(e){const t=n.useContext(o);return n.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:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5697],{20266:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3169",children:"packages/extension-api/src/extension-api.d.ts:3169"})})]})}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 diff --git a/assets/js/e38c422a.d7d01e88.js b/assets/js/e38c422a.bd7a7fea.js similarity index 97% rename from assets/js/e38c422a.d7d01e88.js rename to assets/js/e38c422a.bd7a7fea.js index af58c848227..b2214aff72f 100644 --- a/assets/js/e38c422a.d7d01e88.js +++ b/assets/js/e38c422a.bd7a7fea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[94331],{46413:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L765",children:"packages/extension-api/src/extension-api.d.ts:765"})})]})}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],{46413:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L765",children:"packages/extension-api/src/extension-api.d.ts:765"})})]})}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.77758770.js b/assets/js/e3f28bf9.0ad9b6da.js similarity index 94% rename from assets/js/e3f28bf9.77758770.js rename to assets/js/e3f28bf9.0ad9b6da.js index cb3f12414c9..9f2686584da 100644 --- a/assets/js/e3f28bf9.77758770.js +++ b/assets/js/e3f28bf9.0ad9b6da.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[36248],{94615:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L646",children:"packages/extension-api/src/extension-api.d.ts:646"})})]})}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],{94615:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L646",children:"packages/extension-api/src/extension-api.d.ts:646"})})]})}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.b9c9d264.js b/assets/js/e546fc5a.ef027ada.js similarity index 87% rename from assets/js/e546fc5a.b9c9d264.js rename to assets/js/e546fc5a.ef027ada.js index 69c2b87c15d..130b55d924b 100644 --- a/assets/js/e546fc5a.b9c9d264.js +++ b/assets/js/e546fc5a.ef027ada.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63190],{7761:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L690",children:"packages/extension-api/src/extension-api.d.ts:690"})})]})}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([[63190],{7761:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L690",children:"packages/extension-api/src/extension-api.d.ts:690"})})]})}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 diff --git a/assets/js/e6163b65.cf6f4a78.js b/assets/js/e6163b65.d2f1fd48.js similarity index 82% rename from assets/js/e6163b65.cf6f4a78.js rename to assets/js/e6163b65.d2f1fd48.js index 17b81e35b7a..5b818f4a270 100644 --- a/assets/js/e6163b65.cf6f4a78.js +++ b/assets/js/e6163b65.d2f1fd48.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92045],{9405:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var i=s(24246),t=s(71670);const o={},c="Function: onDidChange()",a={id:"namespaces/extensions/functions/onDidChange",title:"Function: onDidChange()",description:"onDidChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/extensions/functions/onDidChange.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},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,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchange",children:"Function: onDidChange()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChange"}),"(",(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 event which fires when ",(0,i.jsx)(n.code,{children:"extensions.all"})," changes. This can happen when extensions are\ninstalled, uninstalled, enabled or disabled."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L246",children:"packages/extension-api/src/extension-api.d.ts:246"})})]})}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:()=>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 a(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([[92045],{9405:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>r,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const o={},a="Function: onDidChange()",c={id:"namespaces/extensions/functions/onDidChange",title:"Function: onDidChange()",description:"onDidChange(listener, thisArgs?, disposables?): Disposable",source:"@site/api/namespaces/extensions/functions/onDidChange.md",sourceDirName:"namespaces/extensions/functions",slug:"/namespaces/extensions/functions/onDidChange",permalink:"/api/namespaces/extensions/functions/onDidChange",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"getExtension",permalink:"/api/namespaces/extensions/functions/getExtension"},next:{title:"Namespace: fs",permalink:"/api/namespaces/fs/"}},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,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"function-ondidchange",children:"Function: onDidChange()"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"onDidChange"}),"(",(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 event which fires when ",(0,i.jsx)(n.code,{children:"extensions.all"})," changes. This can happen when extensions are\ninstalled, uninstalled, enabled or disabled."]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L246",children:"packages/extension-api/src/extension-api.d.ts:246"})})]})}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:()=>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/e6412603.8403080d.js b/assets/js/e6412603.e1890d43.js similarity index 96% rename from assets/js/e6412603.8403080d.js rename to assets/js/e6412603.e1890d43.js index 5238ec52802..5d7bb9a262a 100644 --- a/assets/js/e6412603.8403080d.js +++ b/assets/js/e6412603.e1890d43.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[92955],{82390:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L745",children:"packages/extension-api/src/extension-api.d.ts:745"})})]})}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],{82390:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L745",children:"packages/extension-api/src/extension-api.d.ts:745"})})]})}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 diff --git a/assets/js/e69dadab.46857492.js b/assets/js/e69dadab.46857492.js new file mode 100644 index 00000000000..900dbf29beb --- /dev/null +++ b/assets/js/e69dadab.46857492.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{52818:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>a});var i=s(24246),o=s(71670);const r={},t="Interface: PodmanContainerCreateOptions",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2654",children:"packages/extension-api/src/extension-api.d.ts:2654"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2656",children:"packages/extension-api/src/extension-api.d.ts:2656"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2659",children:"packages/extension-api/src/extension-api.d.ts:2659"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2661",children:"packages/extension-api/src/extension-api.d.ts:2661"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2657",children:"packages/extension-api/src/extension-api.d.ts:2657"})})]})}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:()=>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/e69dadab.46961ed9.js b/assets/js/e69dadab.46961ed9.js deleted file mode 100644 index a77a9a26ebd..00000000000 --- a/assets/js/e69dadab.46961ed9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75273],{52818:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>d});var c=s(24246),i=s(71670);const o={},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"}},a={},d=[{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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-podmancontainercreateoptions",children:"Interface: PodmanContainerCreateOptions"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"command",children:"command?"}),"\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:"command"}),": ",(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2654",children:"packages/extension-api/src/extension-api.d.ts:2654"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"entrypoint",children:"entrypoint?"}),"\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:"entrypoint"}),": ",(0,c.jsx)(n.code,{children:"string"})," | ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2655",children:"packages/extension-api/src/extension-api.d.ts:2655"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"env",children:"env?"}),"\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:"env"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"key"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2656",children:"packages/extension-api/src/extension-api.d.ts:2656"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"hostname",children:"hostname?"}),"\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:"hostname"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2658",children:"packages/extension-api/src/extension-api.d.ts:2658"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"image",children:"image?"}),"\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:"image"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2659",children:"packages/extension-api/src/extension-api.d.ts:2659"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"mounts",children:"mounts?"}),"\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:"mounts"}),": ",(0,c.jsx)(n.code,{children:"object"}),"[]"]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2661",children:"packages/extension-api/src/extension-api.d.ts:2661"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"name",children:"name?"}),"\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:"name"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2660",children:"packages/extension-api/src/extension-api.d.ts:2660"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"pod",children:"pod?"}),"\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:"pod"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2657",children:"packages/extension-api/src/extension-api.d.ts:2657"})})]})}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:()=>t,a:()=>r});var c=s(27378);const i={},o=c.createContext(i);function r(e){const n=c.useContext(o);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(i):e.components||i:r(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e6c31e60.787f2807.js b/assets/js/e6c31e60.834b7678.js similarity index 84% rename from assets/js/e6c31e60.787f2807.js rename to assets/js/e6c31e60.834b7678.js index eef58585563..05f7fcc63dc 100644 --- a/assets/js/e6c31e60.787f2807.js +++ b/assets/js/e6c31e60.834b7678.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{98521:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L500",children:"packages/extension-api/src/extension-api.d.ts:500"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L498",children:"packages/extension-api/src/extension-api.d.ts:498"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[72931],{98521:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L496",children:"packages/extension-api/src/extension-api.d.ts:496"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L500",children:"packages/extension-api/src/extension-api.d.ts:500"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L498",children:"packages/extension-api/src/extension-api.d.ts:498"})})]})}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 diff --git a/assets/js/e7477a94.3dab8d0e.js b/assets/js/e7477a94.3d66d0ae.js similarity index 78% rename from assets/js/e7477a94.3dab8d0e.js rename to assets/js/e7477a94.3d66d0ae.js index 3692e4903f3..ada8786f128 100644 --- a/assets/js/e7477a94.3dab8d0e.js +++ b/assets/js/e7477a94.3d66d0ae.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{50413:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var t=s(24246),c=s(71670);const i={},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={},a=[{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 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,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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L485",children:"packages/extension-api/src/extension-api.d.ts:485"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})})]})}function h(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:()=>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 o(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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[12864],{50413:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L484",children:"packages/extension-api/src/extension-api.d.ts:484"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L485",children:"packages/extension-api/src/extension-api.d.ts:485"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L486",children:"packages/extension-api/src/extension-api.d.ts:486"})})]})}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.b7c7d6cd.js b/assets/js/e7923b27.4f88f7a2.js similarity index 96% rename from assets/js/e7923b27.b7c7d6cd.js rename to assets/js/e7923b27.4f88f7a2.js index 7f6f72d1a3e..69739a47014 100644 --- a/assets/js/e7923b27.b7c7d6cd.js +++ b/assets/js/e7923b27.4f88f7a2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9055],{18485:(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:"Extension",permalink:"/api/interfaces/Extension"}},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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],{18485:(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:"Extension",permalink:"/api/interfaces/Extension"}},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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.05c7b641.js b/assets/js/e84cabb0.8489b0eb.js similarity index 81% rename from assets/js/e84cabb0.05c7b641.js rename to assets/js/e84cabb0.8489b0eb.js index d30a381d680..64de746503d 100644 --- a/assets/js/e84cabb0.05c7b641.js +++ b/assets/js/e84cabb0.8489b0eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81145],{473:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})})]})}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],{473:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var t=s(24246),r=s(71670);const o={},i="Function: setProxy()",c={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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L688",children:"packages/extension-api/src/extension-api.d.ts:688"})})]})}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:()=>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 diff --git a/assets/js/e88443f3.fde5603b.js b/assets/js/e88443f3.b0bea2b3.js similarity index 77% rename from assets/js/e88443f3.fde5603b.js rename to assets/js/e88443f3.b0bea2b3.js index 21512b22b8d..16057632ead 100644 --- a/assets/js/e88443f3.fde5603b.js +++ b/assets/js/e88443f3.b0bea2b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{54910:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>c,metadata:()=>r,toc:()=>d});var t=s(24246),o=s(71670);const c={},i="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3501",children:"packages/extension-api/src/extension-api.d.ts:3501"})})]})}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:()=>i});var t=s(27378);const o={},c=t.createContext(o);function i(e){const n=t.useContext(c);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:i(e.components),t.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[97953],{54910:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>r,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3501",children:"packages/extension-api/src/extension-api.d.ts:3501"})})]})}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.e2d4f824.js b/assets/js/e983a6d7.92edf219.js similarity index 84% rename from assets/js/e983a6d7.e2d4f824.js rename to assets/js/e983a6d7.92edf219.js index dcaf141f8cf..a4edd47394f 100644 --- a/assets/js/e983a6d7.e2d4f824.js +++ b/assets/js/e983a6d7.92edf219.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{20636:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[61281],{20636:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3787",children:"packages/extension-api/src/extension-api.d.ts:3787"})})]})}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 diff --git a/assets/js/ea3ffc82.72216cf9.js b/assets/js/ea3ffc82.26cff283.js similarity index 84% rename from assets/js/ea3ffc82.72216cf9.js rename to assets/js/ea3ffc82.26cff283.js index 48f22d94161..42c51f54a4a 100644 --- a/assets/js/ea3ffc82.72216cf9.js +++ b/assets/js/ea3ffc82.26cff283.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65494:(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:"Extension",permalink:"/api/interfaces/Extension"},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21181],{65494:(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:"Extension",permalink:"/api/interfaces/Extension"},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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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 diff --git a/assets/js/ed2a4846.313a31d1.js b/assets/js/ed2a4846.e597b57f.js similarity index 76% rename from assets/js/ed2a4846.313a31d1.js rename to assets/js/ed2a4846.e597b57f.js index 5fd3241b8ae..7d229f6eff9 100644 --- a/assets/js/ed2a4846.313a31d1.js +++ b/assets/js/ed2a4846.e597b57f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{41712:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var r=n(24246),s=n(71670);const c={},i="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1951",children:"packages/extension-api/src/extension-api.d.ts:1951"})})]})}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:()=>i});var r=n(27378);const s={},c=r.createContext(s);function i(e){const t=r.useContext(c);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:i(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40486],{41712:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1951",children:"packages/extension-api/src/extension-api.d.ts:1951"})})]})}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 diff --git a/assets/js/ed603d23.72ed4a5a.js b/assets/js/ed603d23.1b9d57d6.js similarity index 85% rename from assets/js/ed603d23.72ed4a5a.js rename to assets/js/ed603d23.1b9d57d6.js index 899dbfb561d..0dcb5bde62b 100644 --- a/assets/js/ed603d23.72ed4a5a.js +++ b/assets/js/ed603d23.1b9d57d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{16598:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1966",children:"packages/extension-api/src/extension-api.d.ts:1966"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1967",children:"packages/extension-api/src/extension-api.d.ts:1967"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1968",children:"packages/extension-api/src/extension-api.d.ts:1968"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73285],{16598:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1966",children:"packages/extension-api/src/extension-api.d.ts:1966"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1967",children:"packages/extension-api/src/extension-api.d.ts:1967"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1968",children:"packages/extension-api/src/extension-api.d.ts:1968"})})]})}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 diff --git a/assets/js/edb40f78.de006f78.js b/assets/js/edb40f78.5f2aa2c5.js similarity index 95% rename from assets/js/edb40f78.de006f78.js rename to assets/js/edb40f78.5f2aa2c5.js index b0c16aeddf0..e56a95b0d8f 100644 --- a/assets/js/edb40f78.de006f78.js +++ b/assets/js/edb40f78.5f2aa2c5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[54632],{5286:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L841",children:"packages/extension-api/src/extension-api.d.ts:841"})})]})}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],{5286:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L841",children:"packages/extension-api/src/extension-api.d.ts:841"})})]})}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.94217804.js b/assets/js/edcfca88.cc3a7f4a.js similarity index 76% rename from assets/js/edcfca88.94217804.js rename to assets/js/edcfca88.cc3a7f4a.js index ae655f25542..4dbe5dba4b9 100644 --- a/assets/js/edcfca88.94217804.js +++ b/assets/js/edcfca88.cc3a7f4a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41902],{1361:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>d});var i=s(24246),c=s(71670);const t={},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,c.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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L393",children:"packages/extension-api/src/extension-api.d.ts:393"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L394",children:"packages/extension-api/src/extension-api.d.ts:394"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L395",children:"packages/extension-api/src/extension-api.d.ts:395"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L407",children:"packages/extension-api/src/extension-api.d.ts:407"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})})]})}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,s)=>{s.d(n,{Z:()=>o,a:()=>r});var i=s(27378);const c={},t=i.createContext(c);function r(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(c):e.components||c:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[41902],{1361:(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="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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L393",children:"packages/extension-api/src/extension-api.d.ts:393"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L394",children:"packages/extension-api/src/extension-api.d.ts:394"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L395",children:"packages/extension-api/src/extension-api.d.ts:395"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L407",children:"packages/extension-api/src/extension-api.d.ts:407"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L408",children:"packages/extension-api/src/extension-api.d.ts:408"})})]})}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/ef5945f7.77136794.js b/assets/js/ef5945f7.4e0f0d58.js similarity index 86% rename from assets/js/ef5945f7.77136794.js rename to assets/js/ef5945f7.4e0f0d58.js index ccf1b2ef526..6e2bee3689b 100644 --- a/assets/js/ef5945f7.77136794.js +++ b/assets/js/ef5945f7.4e0f0d58.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63630],{12294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var i=s(24246),t=s(71670);const c={},r="Interface: Extension",o={id:"interfaces/Extension",title:"Interface: Extension\\",description:"Represents an extension.",source:"@site/api/interfaces/Extension.md",sourceDirName:"interfaces",slug:"/interfaces/Extension",permalink:"/api/interfaces/Extension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Event",permalink:"/api/interfaces/Event"},next:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},a={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"exports",id:"exports",level:3},{value:"Source",id:"source",level:4},{value:"extensionPath",id:"extensionpath",level:3},{value:"Source",id:"source-1",level:4},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"packageJSON",id:"packagejson",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-extensiont",children:"Interface: Extension"}),"\n",(0,i.jsx)(n.p,{children:"Represents an extension."}),"\n",(0,i.jsxs)(n.p,{children:["To get an instance of an ",(0,i.jsx)(n.code,{children:"Extension"})," use ",(0,i.jsx)(n.a,{href:"/api/namespaces/extensions/functions/getExtension",children:"getExtension"}),"."]}),"\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"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"exports",children:"exports"}),"\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:"exports"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The public API exported by this extension (return value of ",(0,i.jsx)(n.code,{children:"activate"}),").\nIt is an invalid action to access this field before this extension has been activated."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L205",children:"packages/extension-api/src/extension-api.d.ts:205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extensionpath",children:"extensionPath"}),"\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:"extensionPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The absolute file path of the directory containing this extension. Shorthand\nnotation for ",(0,i.jsx)(n.a,{href:"/api/interfaces/Extension#extensionuri",children:"Extension.extensionUri.fsPath"})," (independent of the uri scheme)."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L193",children:"packages/extension-api/src/extension-api.d.ts:193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L187",children:"packages/extension-api/src/extension-api.d.ts:187"})}),"\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.jsxs)(n.p,{children:["The canonical extension identifier in the form of: ",(0,i.jsx)(n.code,{children:"publisher.name"}),"."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L182",children:"packages/extension-api/src/extension-api.d.ts:182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"packagejson",children:"packageJSON"}),"\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:"packageJSON"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The parsed contents of the extension's package.json."}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}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:()=>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([[63630],{12294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var i=s(24246),t=s(71670);const r={},o="Interface: Extension",c={id:"interfaces/Extension",title:"Interface: Extension\\",description:"Represents an extension.",source:"@site/api/interfaces/Extension.md",sourceDirName:"interfaces",slug:"/interfaces/Extension",permalink:"/api/interfaces/Extension",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{},sidebar:"typedocSidebar",previous:{title:"Event",permalink:"/api/interfaces/Event"},next:{title:"ExtensionContext",permalink:"/api/interfaces/ExtensionContext"}},a={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"exports",id:"exports",level:3},{value:"Source",id:"source",level:4},{value:"extensionPath",id:"extensionpath",level:3},{value:"Source",id:"source-1",level:4},{value:"extensionUri",id:"extensionuri",level:3},{value:"Source",id:"source-2",level:4},{value:"id",id:"id",level:3},{value:"Source",id:"source-3",level:4},{value:"packageJSON",id:"packagejson",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-extensiont",children:"Interface: Extension"}),"\n",(0,i.jsx)(n.p,{children:"Represents an extension."}),"\n",(0,i.jsxs)(n.p,{children:["To get an instance of an ",(0,i.jsx)(n.code,{children:"Extension"})," use ",(0,i.jsx)(n.a,{href:"/api/namespaces/extensions/functions/getExtension",children:"getExtension"}),"."]}),"\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"})]}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h3,{id:"exports",children:"exports"}),"\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:"exports"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The public API exported by this extension (return value of ",(0,i.jsx)(n.code,{children:"activate"}),").\nIt is an invalid action to access this field before this extension has been activated."]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L205",children:"packages/extension-api/src/extension-api.d.ts:205"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extensionpath",children:"extensionPath"}),"\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:"extensionPath"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The absolute file path of the directory containing this extension. Shorthand\nnotation for ",(0,i.jsx)(n.a,{href:"/api/interfaces/Extension#extensionuri",children:"Extension.extensionUri.fsPath"})," (independent of the uri scheme)."]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L193",children:"packages/extension-api/src/extension-api.d.ts:193"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"extensionuri",children:"extensionUri"}),"\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:"extensionUri"}),": ",(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 uri of the directory containing the extension."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L187",children:"packages/extension-api/src/extension-api.d.ts:187"})}),"\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.jsxs)(n.p,{children:["The canonical extension identifier in the form of: ",(0,i.jsx)(n.code,{children:"publisher.name"}),"."]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L182",children:"packages/extension-api/src/extension-api.d.ts:182"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"packagejson",children:"packageJSON"}),"\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:"packageJSON"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"The parsed contents of the extension's package.json."}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L199",children:"packages/extension-api/src/extension-api.d.ts:199"})})]})}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 diff --git a/assets/js/f1ad83b2.44fb8a3a.js b/assets/js/f1ad83b2.5d172ca6.js similarity index 83% rename from assets/js/f1ad83b2.44fb8a3a.js rename to assets/js/f1ad83b2.5d172ca6.js index f0f35a79ba8..0b505634620 100644 --- a/assets/js/f1ad83b2.44fb8a3a.js +++ b/assets/js/f1ad83b2.5d172ca6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{35522:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>a});var i=r(24246),t=r(71670);const s={},c="Interface: KubernetesProviderConnection",o={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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L417",children:"packages/extension-api/src/extension-api.d.ts:417"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L415",children:"packages/extension-api/src/extension-api.d.ts:415"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L418",children:"packages/extension-api/src/extension-api.d.ts:418"})})]})}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:()=>o,a:()=>c});var i=r(27378);const t={},s=i.createContext(t);function c(e){const n=i.useContext(s);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(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[22182],{35522:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L416",children:"packages/extension-api/src/extension-api.d.ts:416"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L417",children:"packages/extension-api/src/extension-api.d.ts:417"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L415",children:"packages/extension-api/src/extension-api.d.ts:415"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L418",children:"packages/extension-api/src/extension-api.d.ts:418"})})]})}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.da46eae5.js b/assets/js/f20efc55.da46eae5.js deleted file mode 100644 index 35b99896252..00000000000 --- a/assets/js/f20efc55.da46eae5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{61688:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1309",children:"packages/extension-api/src/extension-api.d.ts:1309"})})]})}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/f20efc55.ed8cad13.js b/assets/js/f20efc55.ed8cad13.js new file mode 100644 index 00000000000..c264c60708a --- /dev/null +++ b/assets/js/f20efc55.ed8cad13.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[64438],{61688:(e,t,r)=>{r.r(t),r.d(t,{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(e){const t={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.h1,{id:"variable-statusbaritemdefaultpriority",children:"Variable: StatusBarItemDefaultPriority"}),"\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:"StatusBarItemDefaultPriority"}),": ",(0,a.jsx)(t.code,{children:"0"})," = ",(0,a.jsx)(t.code,{children:"0"})]}),"\n"]}),"\n",(0,a.jsx)(t.p,{children:"Default priority for the 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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1309",children:"packages/extension-api/src/extension-api.d.ts:1309"})})]})}function d(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},71670:(e,t,r)=>{r.d(t,{Z:()=>o,a:()=>s});var a=r(27378);const i={},n=a.createContext(i);function s(e){const t=a.useContext(n);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(i):e.components||i:s(e.components),a.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f27eaf88.795a966f.js b/assets/js/f27eaf88.795a966f.js new file mode 100644 index 00000000000..c26086065c9 --- /dev/null +++ b/assets/js/f27eaf88.795a966f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{13451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>l});var s=t(24246),o=t(71670);const c={},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,o.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L896",children:"packages/extension-api/src/extension-api.d.ts:896"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})})]})}function h(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:()=>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/f27eaf88.d817ef6e.js b/assets/js/f27eaf88.d817ef6e.js deleted file mode 100644 index 1aa41561505..00000000000 --- a/assets/js/f27eaf88.d817ef6e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75741],{13451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>r,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var c=t(24246),s=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,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-cancellationtoken",children:"Interface: CancellationToken"}),"\n",(0,c.jsx)(n.p,{children:"A cancellation token is passed to an asynchronous or long running\noperation to request cancellation."}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"iscancellationrequested",children:"isCancellationRequested"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"isCancellationRequested"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["Is ",(0,c.jsx)(n.code,{children:"true"})," when the token has been cancelled, ",(0,c.jsx)(n.code,{children:"false"})," otherwise."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L896",children:"packages/extension-api/src/extension-api.d.ts:896"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"oncancellationrequested",children:"onCancellationRequested"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"onCancellationRequested"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/Event",children:(0,c.jsx)(n.code,{children:"Event"})}),"<",(0,c.jsx)(n.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,c.jsxs)(n.p,{children:["An ",(0,c.jsx)(n.a,{href:"/api/interfaces/Event",children:"Event"})," which fires upon cancellation."]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L902",children:"packages/extension-api/src/extension-api.d.ts:902"})})]})}function h(e={}){const{wrapper:n}={...(0,s.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:()=>a,a:()=>i});var c=t(27378);const s={},o=c.createContext(s);function i(e){const n=c.useContext(o);return c.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),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f4271232.cf468751.js b/assets/js/f4271232.7fada9eb.js similarity index 95% rename from assets/js/f4271232.cf468751.js rename to assets/js/f4271232.7fada9eb.js index d3bd2832124..df1452b06ea 100644 --- a/assets/js/f4271232.cf468751.js +++ b/assets/js/f4271232.7fada9eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[85799],{96745:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4266",children:"packages/extension-api/src/extension-api.d.ts:4266"})})]})}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],{96745:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4266",children:"packages/extension-api/src/extension-api.d.ts:4266"})})]})}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.bded996d.js b/assets/js/f6cd0d3d.37d49f63.js similarity index 94% rename from assets/js/f6cd0d3d.bded996d.js rename to assets/js/f6cd0d3d.37d49f63.js index b6a9b41cd57..2b1bcb36a66 100644 --- a/assets/js/f6cd0d3d.bded996d.js +++ b/assets/js/f6cd0d3d.37d49f63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[75208],{15805:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L725",children:"packages/extension-api/src/extension-api.d.ts:725"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L726",children:"packages/extension-api/src/extension-api.d.ts:726"})})]})}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],{15805:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L725",children:"packages/extension-api/src/extension-api.d.ts:725"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L726",children:"packages/extension-api/src/extension-api.d.ts:726"})})]})}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.f9f0db23.js b/assets/js/f6cf66bc.a9c9b31e.js similarity index 88% rename from assets/js/f6cf66bc.f9f0db23.js rename to assets/js/f6cf66bc.a9c9b31e.js index 2c9d0d40c11..c9ea9d0fd9c 100644 --- a/assets/js/f6cf66bc.f9f0db23.js +++ b/assets/js/f6cf66bc.a9c9b31e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[65619],{44835:(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="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1917",children:"packages/extension-api/src/extension-api.d.ts:1917"})})]})}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([[65619],{44835:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1917",children:"packages/extension-api/src/extension-api.d.ts:1917"})})]})}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.548000b3.js b/assets/js/f7197f43.0ea08288.js similarity index 86% rename from assets/js/f7197f43.548000b3.js rename to assets/js/f7197f43.0ea08288.js index a97de3b0cd4..8fd4a0988d0 100644 --- a/assets/js/f7197f43.548000b3.js +++ b/assets/js/f7197f43.0ea08288.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[56805],{3574:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>i,contentTitle:()=>a,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var t=r(24246),n=r(71670);const l={},a="Class: TelemetryTrustedValue",c={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"}},i={},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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3959",children:"packages/extension-api/src/extension-api.d.ts:3959"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3957",children:"packages/extension-api/src/extension-api.d.ts:3957"})})]})}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:()=>c,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 c(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],{3574:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3959",children:"packages/extension-api/src/extension-api.d.ts:3959"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3957",children:"packages/extension-api/src/extension-api.d.ts:3957"})})]})}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.0d559153.js b/assets/js/f771dec1.0d559153.js new file mode 100644 index 00000000000..a93c38129f2 --- /dev/null +++ b/assets/js/f771dec1.0d559153.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{62842:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4184",children:"packages/extension-api/src/extension-api.d.ts:4184"})})]})}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/f771dec1.70071305.js b/assets/js/f771dec1.70071305.js deleted file mode 100644 index 52f4f47f23d..00000000000 --- a/assets/js/f771dec1.70071305.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[63863],{62842:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>p,frontMatter:()=>t,metadata:()=>r,toc:()=>a});var c=o(24246),s=o(71670);const t={},i="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,s.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"function-createclitool",children:"Function: createCliTool()"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"createCliTool"}),"(",(0,c.jsx)(n.code,{children:"options"}),"): ",(0,c.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,c.jsx)(n.code,{children:"CliTool"})})]}),"\n"]}),"\n",(0,c.jsx)(n.p,{children:"Register new CLI Tool"}),"\n",(0,c.jsx)(n.h2,{id:"parameters",children:"Parameters"}),"\n",(0,c.jsxs)(n.p,{children:["\u2022 ",(0,c.jsx)(n.strong,{children:"options"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/CliToolOptions",children:(0,c.jsx)(n.code,{children:"CliToolOptions"})})]}),"\n",(0,c.jsx)(n.p,{children:"CliToolsOptions instance to configure new instance of CliTool"}),"\n",(0,c.jsx)(n.h2,{id:"returns",children:"Returns"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"/api/interfaces/CliTool",children:(0,c.jsx)(n.code,{children:"CliTool"})})}),"\n",(0,c.jsx)(n.p,{children:"CliTool instance"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4184",children:"packages/extension-api/src/extension-api.d.ts:4184"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,c.jsx)(n,{...e,children:(0,c.jsx)(d,{...e})}):d(e)}},71670:(e,n,o)=>{o.d(n,{Z:()=>r,a:()=>i});var c=o(27378);const s={},t=c.createContext(s);function i(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:i(e.components),c.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7c9e078.60930748.js b/assets/js/f7c9e078.bbcf6a95.js similarity index 84% rename from assets/js/f7c9e078.60930748.js rename to assets/js/f7c9e078.bbcf6a95.js index edded9aaac1..619e084423b 100644 --- a/assets/js/f7c9e078.60930748.js +++ b/assets/js/f7c9e078.bbcf6a95.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[21364],{80487:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2974",children:"packages/extension-api/src/extension-api.d.ts:2974"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2975",children:"packages/extension-api/src/extension-api.d.ts:2975"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})})]})}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],{80487:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});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"}},d={},a=[{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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2974",children:"packages/extension-api/src/extension-api.d.ts:2974"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2975",children:"packages/extension-api/src/extension-api.d.ts:2975"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2976",children:"packages/extension-api/src/extension-api.d.ts:2976"})})]})}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.166625af.js b/assets/js/f86eb50f.97d4f0f9.js similarity index 91% rename from assets/js/f86eb50f.166625af.js rename to assets/js/f86eb50f.97d4f0f9.js index 25a6eb44724..63a87b1ca62 100644 --- a/assets/js/f86eb50f.166625af.js +++ b/assets/js/f86eb50f.97d4f0f9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{5087:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>c,metadata:()=>s,toc:()=>a});var r=i(24246),o=i(71670);const c={},t="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}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:()=>t});var r=i(27378);const o={},c=r.createContext(o);function t(e){const n=r.useContext(c);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:t(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[48123],{5087:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L430",children:"packages/extension-api/src/extension-api.d.ts:430"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L427",children:"packages/extension-api/src/extension-api.d.ts:427"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L436",children:"packages/extension-api/src/extension-api.d.ts:436"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L424",children:"packages/extension-api/src/extension-api.d.ts:424"})})]})}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.37f69789.js b/assets/js/fb8cd692.37f69789.js deleted file mode 100644 index 87f2f5bef7a..00000000000 --- a/assets/js/fb8cd692.37f69789.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{10252:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>t});var c=s(24246),i=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,i.a)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(n.h1,{id:"interface-hostconfig",children:"Interface: HostConfig"}),"\n",(0,c.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(n.h3,{id:"autoremove",children:"AutoRemove?"}),"\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:"AutoRemove"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2244",children:"packages/extension-api/src/extension-api.d.ts:2244"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"binds",children:"Binds?"}),"\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:"Binds"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkiodevicereadbps",children:"BlkioDeviceReadBps?"}),"\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:"BlkioDeviceReadBps"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2288",children:"packages/extension-api/src/extension-api.d.ts:2288"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkiodevicereadiops",children:"BlkioDeviceReadIOps?"}),"\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:"BlkioDeviceReadIOps"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2290",children:"packages/extension-api/src/extension-api.d.ts:2290"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkiodevicewritebps",children:"BlkioDeviceWriteBps?"}),"\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:"BlkioDeviceWriteBps"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2289",children:"packages/extension-api/src/extension-api.d.ts:2289"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkiodevicewriteiops",children:"BlkioDeviceWriteIOps?"}),"\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:"BlkioDeviceWriteIOps"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2291",children:"packages/extension-api/src/extension-api.d.ts:2291"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkioweight",children:"BlkioWeight?"}),"\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:"BlkioWeight"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2286",children:"packages/extension-api/src/extension-api.d.ts:2286"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"blkioweightdevice",children:"BlkioWeightDevice?"}),"\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:"BlkioWeightDevice"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-7",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2287",children:"packages/extension-api/src/extension-api.d.ts:2287"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"capadd",children:"CapAdd?"}),"\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:"CapAdd"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-8",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2257",children:"packages/extension-api/src/extension-api.d.ts:2257"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"capdrop",children:"CapDrop?"}),"\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:"CapDrop"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-9",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2258",children:"packages/extension-api/src/extension-api.d.ts:2258"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cgroup",children:"Cgroup?"}),"\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:"Cgroup"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-10",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cgroupparent",children:"CgroupParent?"}),"\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:"CgroupParent"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-11",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2285",children:"packages/extension-api/src/extension-api.d.ts:2285"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"consolesize",children:"ConsoleSize?"}),"\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:"ConsoleSize"}),": ",(0,c.jsx)(n.code,{children:"number"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-12",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2280",children:"packages/extension-api/src/extension-api.d.ts:2280"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"containeridfile",children:"ContainerIDFile?"}),"\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:"ContainerIDFile"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-13",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpucount",children:"CpuCount?"}),"\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:"CpuCount"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-14",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2310",children:"packages/extension-api/src/extension-api.d.ts:2310"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpupercent",children:"CpuPercent?"}),"\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:"CpuPercent"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-15",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2311",children:"packages/extension-api/src/extension-api.d.ts:2311"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpuperiod",children:"CpuPeriod?"}),"\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:"CpuPeriod"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-16",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpuquota",children:"CpuQuota?"}),"\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:"CpuQuota"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-17",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2293",children:"packages/extension-api/src/extension-api.d.ts:2293"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpurealtimeperiod",children:"CpuRealtimePeriod?"}),"\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:"CpuRealtimePeriod"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-18",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2312",children:"packages/extension-api/src/extension-api.d.ts:2312"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpurealtimeruntime",children:"CpuRealtimeRuntime?"}),"\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:"CpuRealtimeRuntime"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-19",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2313",children:"packages/extension-api/src/extension-api.d.ts:2313"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpushares",children:"CpuShares?"}),"\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:"CpuShares"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-20",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2284",children:"packages/extension-api/src/extension-api.d.ts:2284"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpusetcpus",children:"CpusetCpus?"}),"\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:"CpusetCpus"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-21",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2294",children:"packages/extension-api/src/extension-api.d.ts:2294"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"cpusetmems",children:"CpusetMems?"}),"\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:"CpusetMems"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-22",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2295",children:"packages/extension-api/src/extension-api.d.ts:2295"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"devicecgrouprules",children:"DeviceCgroupRules?"}),"\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:"DeviceCgroupRules"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-23",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2297",children:"packages/extension-api/src/extension-api.d.ts:2297"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"devicerequests",children:"DeviceRequests?"}),"\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:"DeviceRequests"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/DeviceRequest",children:(0,c.jsx)(n.code,{children:"DeviceRequest"})}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-24",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"devices",children:"Devices?"}),"\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:"Devices"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-25",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2296",children:"packages/extension-api/src/extension-api.d.ts:2296"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"diskquota",children:"DiskQuota?"}),"\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:"DiskQuota"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-26",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dns",children:"Dns?"}),"\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:"Dns"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-27",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2259",children:"packages/extension-api/src/extension-api.d.ts:2259"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dnsoptions",children:"DnsOptions?"}),"\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:"DnsOptions"}),": ",(0,c.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-28",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2260",children:"packages/extension-api/src/extension-api.d.ts:2260"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"dnssearch",children:"DnsSearch?"}),"\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:"DnsSearch"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-29",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"extrahosts",children:"ExtraHosts?"}),"\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:"ExtraHosts"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-30",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"groupadd",children:"GroupAdd?"}),"\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:"GroupAdd"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-31",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2263",children:"packages/extension-api/src/extension-api.d.ts:2263"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"init",children:"Init?"}),"\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:"Init"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-32",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2307",children:"packages/extension-api/src/extension-api.d.ts:2307"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ipcmode",children:"IpcMode?"}),"\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:"IpcMode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-33",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2264",children:"packages/extension-api/src/extension-api.d.ts:2264"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"isolation",children:"Isolation?"}),"\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:"Isolation"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-34",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2281",children:"packages/extension-api/src/extension-api.d.ts:2281"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"kernelmemory",children:"KernelMemory?"}),"\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:"KernelMemory"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-35",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2300",children:"packages/extension-api/src/extension-api.d.ts:2300"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"links",children:"Links?"}),"\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:"Links"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-36",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"logconfig",children:"LogConfig?"}),"\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:"LogConfig"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"config",children:"Config"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Config"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"type",children:"Type"}),"\n",(0,c.jsxs)(n.blockquote,{children:["\n",(0,c.jsxs)(n.p,{children:[(0,c.jsx)(n.strong,{children:"Type"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-37",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"maskedpaths",children:"MaskedPaths?"}),"\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:"MaskedPaths"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-38",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memory",children:"Memory?"}),"\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:"Memory"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-39",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2301",children:"packages/extension-api/src/extension-api.d.ts:2301"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memoryreservation",children:"MemoryReservation?"}),"\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:"MemoryReservation"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-40",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2302",children:"packages/extension-api/src/extension-api.d.ts:2302"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memoryswap",children:"MemorySwap?"}),"\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:"MemorySwap"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-41",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2303",children:"packages/extension-api/src/extension-api.d.ts:2303"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"memoryswappiness",children:"MemorySwappiness?"}),"\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:"MemorySwappiness"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-42",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2304",children:"packages/extension-api/src/extension-api.d.ts:2304"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"mounts",children:"Mounts?"}),"\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:"Mounts"}),": ",(0,c.jsx)(n.a,{href:"/api/type-aliases/MountConfig",children:(0,c.jsx)(n.code,{children:"MountConfig"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-43",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2256",children:"packages/extension-api/src/extension-api.d.ts:2256"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"nanocpus",children:"NanoCpus?"}),"\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:"NanoCpus"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-44",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2305",children:"packages/extension-api/src/extension-api.d.ts:2305"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"networkmode",children:"NetworkMode?"}),"\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:"NetworkMode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-45",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"oomkilldisable",children:"OomKillDisable?"}),"\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:"OomKillDisable"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-46",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2306",children:"packages/extension-api/src/extension-api.d.ts:2306"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"oomscoreadj",children:"OomScoreAdj?"}),"\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:"OomScoreAdj"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-47",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"pidmode",children:"PidMode?"}),"\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:"PidMode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-48",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"pidslimit",children:"PidsLimit?"}),"\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:"PidsLimit"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-49",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2308",children:"packages/extension-api/src/extension-api.d.ts:2308"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"portbindings",children:"PortBindings?"}),"\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:"PortBindings"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-50",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2252",children:"packages/extension-api/src/extension-api.d.ts:2252"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"privileged",children:"Privileged?"}),"\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:"Privileged"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-51",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"publishallports",children:"PublishAllPorts?"}),"\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:"PublishAllPorts"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-52",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"readonlypaths",children:"ReadonlyPaths?"}),"\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:"ReadonlyPaths"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-53",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2283",children:"packages/extension-api/src/extension-api.d.ts:2283"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"readonlyrootfs",children:"ReadonlyRootfs?"}),"\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:"ReadonlyRootfs"}),": ",(0,c.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-54",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"restartpolicy",children:"RestartPolicy?"}),"\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:"RestartPolicy"}),": ",(0,c.jsx)(n.a,{href:"/api/interfaces/HostRestartPolicy",children:(0,c.jsx)(n.code,{children:"HostRestartPolicy"})})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-55",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2253",children:"packages/extension-api/src/extension-api.d.ts:2253"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"runtime",children:"Runtime?"}),"\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:"Runtime"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-56",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2279",children:"packages/extension-api/src/extension-api.d.ts:2279"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"securityopt",children:"SecurityOpt?"}),"\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:"SecurityOpt"}),": ",(0,c.jsx)(n.code,{children:"string"}),"[]"]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-57",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"shmsize",children:"ShmSize?"}),"\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:"ShmSize"}),": ",(0,c.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-58",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"storageopt",children:"StorageOpt?"}),"\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:"StorageOpt"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"option"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-59",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"sysctls",children:"Sysctls?"}),"\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:"Sysctls"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-1",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"index"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-60",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2278",children:"packages/extension-api/src/extension-api.d.ts:2278"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"tmpfs",children:"Tmpfs?"}),"\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:"Tmpfs"}),": ",(0,c.jsx)(n.code,{children:"object"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"index-signature-2",children:"Index signature"}),"\n",(0,c.jsxs)(n.p,{children:["[",(0,c.jsx)(n.code,{children:"dir"}),": ",(0,c.jsx)(n.code,{children:"string"}),"]: ",(0,c.jsx)(n.code,{children:"string"})]}),"\n",(0,c.jsx)(n.h4,{id:"source-61",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"utsmode",children:"UTSMode?"}),"\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:"UTSMode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-62",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"ulimits",children:"Ulimits?"}),"\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:"Ulimits"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-63",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2309",children:"packages/extension-api/src/extension-api.d.ts:2309"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"usernsmode",children:"UsernsMode?"}),"\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:"UsernsMode"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-64",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"volumedriver",children:"VolumeDriver?"}),"\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:"VolumeDriver"}),": ",(0,c.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-65",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2254",children:"packages/extension-api/src/extension-api.d.ts:2254"})}),"\n",(0,c.jsx)(n.hr,{}),"\n",(0,c.jsx)(n.h3,{id:"volumesfrom",children:"VolumesFrom?"}),"\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:"VolumesFrom"}),": ",(0,c.jsx)(n.code,{children:"unknown"})]}),"\n"]}),"\n",(0,c.jsx)(n.h4,{id:"source-66",children:"Source"}),"\n",(0,c.jsx)(n.p,{children:(0,c.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})})]})}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:()=>d,a:()=>r});var c=s(27378);const i={},o=c.createContext(i);function r(e){const n=c.useContext(o);return c.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:r(e.components),c.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fb8cd692.a440bb75.js b/assets/js/fb8cd692.a440bb75.js new file mode 100644 index 00000000000..54f2b851888 --- /dev/null +++ b/assets/js/fb8cd692.a440bb75.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[80511],{10252:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>t});var i=s(24246),o=s(71670);const c={},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,o.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2244",children:"packages/extension-api/src/extension-api.d.ts:2244"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2245",children:"packages/extension-api/src/extension-api.d.ts:2245"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2288",children:"packages/extension-api/src/extension-api.d.ts:2288"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2290",children:"packages/extension-api/src/extension-api.d.ts:2290"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2289",children:"packages/extension-api/src/extension-api.d.ts:2289"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2291",children:"packages/extension-api/src/extension-api.d.ts:2291"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2257",children:"packages/extension-api/src/extension-api.d.ts:2257"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2258",children:"packages/extension-api/src/extension-api.d.ts:2258"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2265",children:"packages/extension-api/src/extension-api.d.ts:2265"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2280",children:"packages/extension-api/src/extension-api.d.ts:2280"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2246",children:"packages/extension-api/src/extension-api.d.ts:2246"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2292",children:"packages/extension-api/src/extension-api.d.ts:2292"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2293",children:"packages/extension-api/src/extension-api.d.ts:2293"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2294",children:"packages/extension-api/src/extension-api.d.ts:2294"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2295",children:"packages/extension-api/src/extension-api.d.ts:2295"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2297",children:"packages/extension-api/src/extension-api.d.ts:2297"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2298",children:"packages/extension-api/src/extension-api.d.ts:2298"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2296",children:"packages/extension-api/src/extension-api.d.ts:2296"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2299",children:"packages/extension-api/src/extension-api.d.ts:2299"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2259",children:"packages/extension-api/src/extension-api.d.ts:2259"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2260",children:"packages/extension-api/src/extension-api.d.ts:2260"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2261",children:"packages/extension-api/src/extension-api.d.ts:2261"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2262",children:"packages/extension-api/src/extension-api.d.ts:2262"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2263",children:"packages/extension-api/src/extension-api.d.ts:2263"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2264",children:"packages/extension-api/src/extension-api.d.ts:2264"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2300",children:"packages/extension-api/src/extension-api.d.ts:2300"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2266",children:"packages/extension-api/src/extension-api.d.ts:2266"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2247",children:"packages/extension-api/src/extension-api.d.ts:2247"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2282",children:"packages/extension-api/src/extension-api.d.ts:2282"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2256",children:"packages/extension-api/src/extension-api.d.ts:2256"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2251",children:"packages/extension-api/src/extension-api.d.ts:2251"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2267",children:"packages/extension-api/src/extension-api.d.ts:2267"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2268",children:"packages/extension-api/src/extension-api.d.ts:2268"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2252",children:"packages/extension-api/src/extension-api.d.ts:2252"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2269",children:"packages/extension-api/src/extension-api.d.ts:2269"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2270",children:"packages/extension-api/src/extension-api.d.ts:2270"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2271",children:"packages/extension-api/src/extension-api.d.ts:2271"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2253",children:"packages/extension-api/src/extension-api.d.ts:2253"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2279",children:"packages/extension-api/src/extension-api.d.ts:2279"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2272",children:"packages/extension-api/src/extension-api.d.ts:2272"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2277",children:"packages/extension-api/src/extension-api.d.ts:2277"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2273",children:"packages/extension-api/src/extension-api.d.ts:2273"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2278",children:"packages/extension-api/src/extension-api.d.ts:2278"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2274",children:"packages/extension-api/src/extension-api.d.ts:2274"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2275",children:"packages/extension-api/src/extension-api.d.ts:2275"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/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:"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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2276",children:"packages/extension-api/src/extension-api.d.ts:2276"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2254",children:"packages/extension-api/src/extension-api.d.ts:2254"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L2255",children:"packages/extension-api/src/extension-api.d.ts:2255"})})]})}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:()=>r,a:()=>d});var i=s(27378);const o={},c=i.createContext(o);function d(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(o):e.components||o:d(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fbfd390f.77efd6e8.js b/assets/js/fbfd390f.a1cff278.js similarity index 86% rename from assets/js/fbfd390f.77efd6e8.js rename to assets/js/fbfd390f.a1cff278.js index a369d18f10d..a8928f8e8e6 100644 --- a/assets/js/fbfd390f.77efd6e8.js +++ b/assets/js/fbfd390f.a1cff278.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[95921],{27916:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});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"}},a={},d=[{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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})})]})}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],{27916:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L451",children:"packages/extension-api/src/extension-api.d.ts:451"})})]})}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.54f3e2ff.js b/assets/js/fc923f19.54f3e2ff.js new file mode 100644 index 00000000000..7ea246540a8 --- /dev/null +++ b/assets/js/fc923f19.54f3e2ff.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{96868:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4206",children:"packages/extension-api/src/extension-api.d.ts:4206"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4194",children:"packages/extension-api/src/extension-api.d.ts:4194"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4202",children:"packages/extension-api/src/extension-api.d.ts:4202"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4198",children:"packages/extension-api/src/extension-api.d.ts:4198"})})]})}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/fc923f19.dc3cb0bb.js b/assets/js/fc923f19.dc3cb0bb.js deleted file mode 100644 index b330494faea..00000000000 --- a/assets/js/fc923f19.dc3cb0bb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[73177],{96868:(e,n,c)=>{c.r(n),c.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var s=c(24246),r=c(71670);const i={},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,r.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"interface-imagecheck",children:"Interface: ImageCheck"}),"\n",(0,s.jsx)(n.p,{children:"a specific error/recommendation found during an image check"}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"markdowndescription",children:"markdownDescription?"}),"\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:"markdownDescription"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"full description of the error/recommendation"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4206",children:"packages/extension-api/src/extension-api.d.ts:4206"})}),"\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.p,{children:"a short and descriptive name for the error/recommendation"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4194",children:"packages/extension-api/src/extension-api.d.ts:4194"})}),"\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:"optional"})," ",(0,s.jsx)(n.strong,{children:"severity"}),": ",(0,s.jsx)(n.code,{children:'"high"'})," | ",(0,s.jsx)(n.code,{children:'"low"'})," | ",(0,s.jsx)(n.code,{children:'"medium"'})," | ",(0,s.jsx)(n.code,{children:'"critical"'})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["severity of the error/recommendation, when the status is ",(0,s.jsx)(n.code,{children:"failed"})]}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4202",children:"packages/extension-api/src/extension-api.d.ts:4202"})}),"\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:'"failed"'})," | ",(0,s.jsx)(n.code,{children:'"success"'})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"either the feedback is positive or negative"}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4198",children:"packages/extension-api/src/extension-api.d.ts:4198"})})]})}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,c)=>{c.d(n,{Z:()=>o,a:()=>t});var s=c(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 o(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 diff --git a/assets/js/fd702dc7.46ac2884.js b/assets/js/fd702dc7.d63d1cb5.js similarity index 97% rename from assets/js/fd702dc7.46ac2884.js rename to assets/js/fd702dc7.d63d1cb5.js index bea22779a38..7174fac95af 100644 --- a/assets/js/fd702dc7.46ac2884.js +++ b/assets/js/fd702dc7.d63d1cb5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[57694],{71523:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L1505",children:"packages/extension-api/src/extension-api.d.ts:1505"})})]})}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],{71523:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L1505",children:"packages/extension-api/src/extension-api.d.ts:1505"})})]})}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.cd7eee62.js b/assets/js/fe1a05e2.c58f75a8.js similarity index 96% rename from assets/js/fe1a05e2.cd7eee62.js rename to assets/js/fe1a05e2.c58f75a8.js index 2622f63b502..8d9c815b058 100644 --- a/assets/js/fe1a05e2.cd7eee62.js +++ b/assets/js/fe1a05e2.c58f75a8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[70900],{64243:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L761",children:"packages/extension-api/src/extension-api.d.ts:761"})})]})}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],{64243:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L761",children:"packages/extension-api/src/extension-api.d.ts:761"})})]})}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.a9836ca8.js b/assets/js/fe716911.a9836ca8.js deleted file mode 100644 index 8efb26443ed..00000000000 --- a/assets/js/fe716911.a9836ca8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{71774:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L477",children:"packages/extension-api/src/extension-api.d.ts:477"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L479",children:"packages/extension-api/src/extension-api.d.ts:479"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L480",children:"packages/extension-api/src/extension-api.d.ts:480"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})})]})}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 diff --git a/assets/js/fe716911.ccd539d9.js b/assets/js/fe716911.ccd539d9.js new file mode 100644 index 00000000000..ef60462c965 --- /dev/null +++ b/assets/js/fe716911.ccd539d9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[33940],{71774:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var i=s(24246),c=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,c.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"interface-checkresult",children:"Interface: CheckResult"}),"\n",(0,i.jsx)(n.h2,{id:"properties",children:"Properties"}),"\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.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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L477",children:"packages/extension-api/src/extension-api.d.ts:477"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"doclinks",children:"docLinks?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"docLinks"}),": ",(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-1",children:"Source"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/containers/podman-desktop/blob/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L479",children:"packages/extension-api/src/extension-api.d.ts:479"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"doclinksdescription",children:"docLinksDescription?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"docLinksDescription"}),": ",(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L478",children:"packages/extension-api/src/extension-api.d.ts:478"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"fixcommand",children:"fixCommand?"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"optional"})," ",(0,i.jsx)(n.strong,{children:"fixCommand"}),": ",(0,i.jsx)(n.a,{href:"/api/interfaces/CheckResultFixCommand",children:(0,i.jsx)(n.code,{children:"CheckResultFixCommand"})})]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L480",children:"packages/extension-api/src/extension-api.d.ts:480"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"successful",children:"successful"}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"successful"}),": ",(0,i.jsx)(n.code,{children:"boolean"})]}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L476",children:"packages/extension-api/src/extension-api.d.ts:476"})})]})}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:()=>t});var i=s(27378);const c={},o=i.createContext(c);function t(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:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fee0a0be.5c2ec231.js b/assets/js/fee0a0be.140bd50a.js similarity index 79% rename from assets/js/fee0a0be.5c2ec231.js rename to assets/js/fee0a0be.140bd50a.js index 1344c6922b9..68958df00d2 100644 --- a/assets/js/fee0a0be.5c2ec231.js +++ b/assets/js/fee0a0be.140bd50a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{76926:(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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3195",children:"packages/extension-api/src/extension-api.d.ts:3195"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3191",children:"packages/extension-api/src/extension-api.d.ts:3191"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3207",children:"packages/extension-api/src/extension-api.d.ts:3207"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3211",children:"packages/extension-api/src/extension-api.d.ts:3211"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3179",children:"packages/extension-api/src/extension-api.d.ts:3179"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3183",children:"packages/extension-api/src/extension-api.d.ts:3183"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3187",children:"packages/extension-api/src/extension-api.d.ts:3187"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3199",children:"packages/extension-api/src/extension-api.d.ts:3199"})}),"\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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L3203",children:"packages/extension-api/src/extension-api.d.ts:3203"})})]})}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 +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[81580],{76926:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3195",children:"packages/extension-api/src/extension-api.d.ts:3195"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3191",children:"packages/extension-api/src/extension-api.d.ts:3191"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3207",children:"packages/extension-api/src/extension-api.d.ts:3207"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3211",children:"packages/extension-api/src/extension-api.d.ts:3211"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3179",children:"packages/extension-api/src/extension-api.d.ts:3179"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3183",children:"packages/extension-api/src/extension-api.d.ts:3183"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3187",children:"packages/extension-api/src/extension-api.d.ts:3187"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3199",children:"packages/extension-api/src/extension-api.d.ts:3199"})}),"\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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L3203",children:"packages/extension-api/src/extension-api.d.ts:3203"})})]})}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 diff --git a/assets/js/ff2f63f6.c878bb76.js b/assets/js/ff2f63f6.331c8cb8.js similarity index 80% rename from assets/js/ff2f63f6.c878bb76.js rename to assets/js/ff2f63f6.331c8cb8.js index 19a072a795d..3de8b878169 100644 --- a/assets/js/ff2f63f6.c878bb76.js +++ b/assets/js/ff2f63f6.331c8cb8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{832:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>c,metadata:()=>o,toc:()=>d});var r=n(24246),a=n(71670);const c={},s="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/c822920e1fc5cc6f79c6f64ac8f21016f6a785bd/packages/extension-api/src/extension-api.d.ts#L4320",children:"packages/extension-api/src/extension-api.d.ts:4320"})})]})}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:()=>s});var r=n(27378);const a={},c=r.createContext(a);function s(e){const t=r.useContext(c);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:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[68097],{832:(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/36e2c0ed99e4fe436b004d5fea9ef91d719eeeef/packages/extension-api/src/extension-api.d.ts#L4320",children:"packages/extension-api/src/extension-api.d.ts:4320"})})]})}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/main.1b1e2beb.js b/assets/js/main.89fa5fce.js similarity index 72% rename from assets/js/main.1b1e2beb.js rename to assets/js/main.89fa5fce.js index d8472ba1313..b5370ff6000 100644 --- a/assets/js/main.1b1e2beb.js +++ b/assets/js/main.89fa5fce.js @@ -1,2 +1,2 @@ -/*! For license information please see main.1b1e2beb.js.LICENSE.txt */ -(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[40179],{56573:(e,t,n)=>{"use strict";n.d(t,{W:()=>i});var a=n(27378);function i(){return a.createElement("svg",{width:"20",height:"20",className:"DocSearch-Search-Icon",viewBox:"0 0 20 20"},a.createElement("path",{d:"M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z",stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"}))}},23427:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>r});var a=n(27378),i=n(24246);const o=a.createContext(!1);function r(e){let{children:t}=e;const[n,r]=(0,a.useState)(!1);return(0,a.useEffect)((()=>{r(!0)}),[]),(0,i.jsx)(o.Provider,{value:n,children:t})}},93002:(e,t,n)=>{"use strict";var a=n(27378),i=n(37634),o=n(92883),r=n(20988),s=n(36809),c=n(161);const l=[n(70142),n(23815),n(54374),n(26222)];var d=n(76623),u=n(48165),p=n(95473),f=n(24246);function m(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var b=n(7092),g=n(50353),h=n(98948),y=n(20624),v=n(88676),k=n(43714),S=n(70174),x=n(13149),w=n(51721),_=n(60505);function C(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.Z)(),a=(0,k.l)(),i=n[e].htmlLang,o=e=>e.replace("-","_");return(0,f.jsxs)(b.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:o(i)}),Object.values(n).filter((e=>i!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function E(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.Z)(),a=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.Z)(),{pathname:a}=(0,u.TH)();return e+(0,w.applyTrailingSlash)((0,h.ZP)(a),{trailingSlash:n,baseUrl:t})}(),i=t?`${n}${t}`:a;return(0,f.jsxs)(b.Z,{children:[(0,f.jsx)("meta",{property:"og:url",content:i}),(0,f.jsx)("link",{rel:"canonical",href:i})]})}function P(){const{i18n:{currentLocale:e}}=(0,g.Z)(),{metadata:t,image:n}=(0,y.L)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(b.Z,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:S.h})]}),n&&(0,f.jsx)(v.d,{image:n}),(0,f.jsx)(E,{}),(0,f.jsx)(C,{}),(0,f.jsx)(_.Z,{tag:x.HX,locale:e}),(0,f.jsx)(b.Z,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const T=new Map;var I=n(23427),A=n(83340),R=n(9834);function O(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),a=1;a{const a=t.default?.[e]??t[e];return a?.(...n)}));return()=>i.forEach((e=>e?.()))}const L=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,R.Z)((()=>{a!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const a=t.pathname===n.pathname,i=t.hash===n.hash,o=t.search===n.search;if(a&&i&&!o)return;const{hash:r}=t;if(r){const e=decodeURIComponent(r.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:a}),O("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function N(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,p.f)(d.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class j extends a.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=c.Z.canUseDOM?O("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=O("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),N(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,f.jsx)(L,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(u.AW,{location:t,render:()=>e})})}}const D=j,M="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",B="__docusaurus-base-url-issue-banner-suggestion-container";function U(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}((0,u.TH)());return(0,f.jsx)(D,{location:e,children:K})}function q(){return(0,f.jsx)(V.Z,{children:(0,f.jsx)(A.M,{children:(0,f.jsxs)(I.t,{children:[(0,f.jsxs)(m,{children:[(0,f.jsx)(H,{}),(0,f.jsx)(P,{}),(0,f.jsx)(z,{}),(0,f.jsx)(G,{})]}),(0,f.jsx)(Z,{})]})})})}var Q=n(16887);const Y=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const a=document.createElement("link");a.setAttribute("rel","prefetch"),a.setAttribute("href",e),a.onload=()=>t(),a.onerror=()=>n();const i=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;i?.appendChild(a)}))}:function(e){return new Promise(((t,n)=>{const a=new XMLHttpRequest;a.open("GET",e,!0),a.withCredentials=!0,a.onload=()=>{200===a.status?t():n()},a.send(null)}))};var X=n(13361);const J=new Set,ee=new Set,te=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ne={prefetch:e=>{if(!(e=>!te()&&!ee.has(e)&&!J.has(e))(e))return!1;J.add(e);const t=(0,p.f)(d.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(Q).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,X.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Y(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!te()&&!ee.has(e))(e)&&(ee.add(e),N(e))},ae=Object.freeze(ne);function ie(e){let{children:t}=e;return"hash"===s.default.future.experimental_router?(0,f.jsx)(r.UT,{children:t}):(0,f.jsx)(r.VK,{children:t})}const oe=Boolean(!0);if(c.Z.canUseDOM){window.docusaurus=ae;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(o.B6,{children:(0,f.jsx)(ie,{children:(0,f.jsx)(q,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},r=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(oe)window.docusaurusRoot=i.hydrateRoot(e,t,{onRecoverableError:n});else{const a=i.createRoot(e,{onRecoverableError:n});a.render(t),window.docusaurusRoot=a}};N(window.location.pathname).then((()=>{(0,a.startTransition)(r)}))}},83340:(e,t,n)=>{"use strict";n.d(t,{_:()=>u,M:()=>p});var a=n(27378),i=n(36809);const o=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"intro","docs":[{"id":"ai-lab/create-playground","path":"/docs/ai-lab/create-playground","sidebar":"mySidebar"},{"id":"ai-lab/download-model","path":"/docs/ai-lab/download-model","sidebar":"mySidebar"},{"id":"ai-lab/index","path":"/docs/ai-lab/","sidebar":"mySidebar"},{"id":"ai-lab/installing","path":"/docs/ai-lab/installing","sidebar":"mySidebar"},{"id":"ai-lab/start-inference-server","path":"/docs/ai-lab/start-inference-server","sidebar":"mySidebar"},{"id":"ai-lab/start-recipe","path":"/docs/ai-lab/start-recipe","sidebar":"mySidebar"},{"id":"compose/index","path":"/docs/compose/","sidebar":"mySidebar"},{"id":"compose/running-compose","path":"/docs/compose/running-compose","sidebar":"mySidebar"},{"id":"compose/setting-up-compose","path":"/docs/compose/setting-up-compose","sidebar":"mySidebar"},{"id":"compose/troubleshooting","path":"/docs/compose/troubleshooting","sidebar":"mySidebar"},{"id":"containers/creating-a-pod","path":"/docs/containers/creating-a-pod","sidebar":"mySidebar"},{"id":"containers/images/building-an-image","path":"/docs/containers/images/building-an-image","sidebar":"mySidebar"},{"id":"containers/images/index","path":"/docs/containers/images/","sidebar":"mySidebar"},{"id":"containers/images/pulling-an-image","path":"/docs/containers/images/pulling-an-image","sidebar":"mySidebar"},{"id":"containers/images/pushing-an-image-to-a-registry","path":"/docs/containers/images/pushing-an-image-to-a-registry","sidebar":"mySidebar"},{"id":"containers/index","path":"/docs/containers/","sidebar":"mySidebar"},{"id":"containers/onboarding","path":"/docs/containers/onboarding","sidebar":"mySidebar"},{"id":"containers/registries/index","path":"/docs/containers/registries/","sidebar":"mySidebar"},{"id":"containers/starting-a-container","path":"/docs/containers/starting-a-container","sidebar":"mySidebar"},{"id":"extensions/api/index","path":"/docs/extensions/api/","sidebar":"mySidebar"},{"id":"extensions/developing/adding-icons","path":"/docs/extensions/developing/adding-icons","sidebar":"mySidebar"},{"id":"extensions/developing/command-palette","path":"/docs/extensions/developing/command-palette","sidebar":"mySidebar"},{"id":"extensions/developing/commands","path":"/docs/extensions/developing/commands","sidebar":"mySidebar"},{"id":"extensions/developing/config","path":"/docs/extensions/developing/config","sidebar":"mySidebar"},{"id":"extensions/developing/index","path":"/docs/extensions/developing/","sidebar":"mySidebar"},{"id":"extensions/developing/menu","path":"/docs/extensions/developing/menu","sidebar":"mySidebar"},{"id":"extensions/developing/onboarding-workflow","path":"/docs/extensions/developing/onboarding-workflow","sidebar":"mySidebar"},{"id":"extensions/developing/when-clause-context","path":"/docs/extensions/developing/when-clause-context","sidebar":"mySidebar"},{"id":"extensions/index","path":"/docs/extensions/","sidebar":"mySidebar"},{"id":"extensions/install/index","path":"/docs/extensions/install/","sidebar":"mySidebar"},{"id":"extensions/publish/index","path":"/docs/extensions/publish/","sidebar":"mySidebar"},{"id":"installation/index","path":"/docs/installation/","sidebar":"mySidebar"},{"id":"installation/linux-install/index","path":"/docs/installation/linux-install/","sidebar":"mySidebar"},{"id":"installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle","path":"/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle","sidebar":"mySidebar"},{"id":"installation/macos-install","path":"/docs/installation/macos-install","sidebar":"mySidebar"},{"id":"installation/windows-install/index","path":"/docs/installation/windows-install/","sidebar":"mySidebar"},{"id":"intro","path":"/docs/intro","sidebar":"mySidebar"},{"id":"kind/building-an-image-and-testing-it-in-kind","path":"/docs/kind/building-an-image-and-testing-it-in-kind","sidebar":"mySidebar"},{"id":"kind/configuring-podman-for-kind-on-windows","path":"/docs/kind/configuring-podman-for-kind-on-windows","sidebar":"mySidebar"},{"id":"kind/creating-a-kind-cluster","path":"/docs/kind/creating-a-kind-cluster","sidebar":"mySidebar"},{"id":"kind/deleting-your-kind-cluster","path":"/docs/kind/deleting-your-kind-cluster","sidebar":"mySidebar"},{"id":"kind/index","path":"/docs/kind/","sidebar":"mySidebar"},{"id":"kind/installing","path":"/docs/kind/installing","sidebar":"mySidebar"},{"id":"kind/pushing-an-image-to-kind","path":"/docs/kind/pushing-an-image-to-kind","sidebar":"mySidebar"},{"id":"kind/restarting-your-kind-cluster","path":"/docs/kind/restarting-your-kind-cluster","sidebar":"mySidebar"},{"id":"kind/working-with-your-local-kind-cluster","path":"/docs/kind/working-with-your-local-kind-cluster","sidebar":"mySidebar"},{"id":"kubernetes/deploying-a-container-to-kubernetes","path":"/docs/kubernetes/deploying-a-container-to-kubernetes","sidebar":"mySidebar"},{"id":"kubernetes/deploying-a-pod-to-kubernetes","path":"/docs/kubernetes/deploying-a-pod-to-kubernetes","sidebar":"mySidebar"},{"id":"kubernetes/existing-kubernetes/index","path":"/docs/kubernetes/existing-kubernetes/","sidebar":"mySidebar"},{"id":"kubernetes/index","path":"/docs/kubernetes/","sidebar":"mySidebar"},{"id":"kubernetes/kind/pushing-an-image-to-kind","path":"/docs/kubernetes/kind/pushing-an-image-to-kind","sidebar":"mySidebar"},{"id":"kubernetes/lima/pushing-an-image-to-lima","path":"/docs/kubernetes/lima/pushing-an-image-to-lima","sidebar":"mySidebar"},{"id":"kubernetes/minikube/pushing-an-image-to-minikube","path":"/docs/kubernetes/minikube/pushing-an-image-to-minikube","sidebar":"mySidebar"},{"id":"kubernetes/viewing-and-selecting-current-kubernete-context","path":"/docs/kubernetes/viewing-and-selecting-current-kubernete-context","sidebar":"mySidebar"},{"id":"kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar","path":"/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar","sidebar":"mySidebar"},{"id":"lima/creating-a-kubernetes-instance","path":"/docs/lima/creating-a-kubernetes-instance","sidebar":"mySidebar"},{"id":"lima/creating-a-lima-instance","path":"/docs/lima/creating-a-lima-instance","sidebar":"mySidebar"},{"id":"lima/customizing","path":"/docs/lima/customizing","sidebar":"mySidebar"},{"id":"lima/index","path":"/docs/lima/","sidebar":"mySidebar"},{"id":"lima/installing","path":"/docs/lima/installing","sidebar":"mySidebar"},{"id":"migrating-from-docker/emulating-docker-cli-with-podman","path":"/docs/migrating-from-docker/emulating-docker-cli-with-podman","sidebar":"mySidebar"},{"id":"migrating-from-docker/importing-saved-containers","path":"/docs/migrating-from-docker/importing-saved-containers","sidebar":"mySidebar"},{"id":"migrating-from-docker/index","path":"/docs/migrating-from-docker/","sidebar":"mySidebar"},{"id":"migrating-from-docker/using-podman-mac-helper","path":"/docs/migrating-from-docker/using-podman-mac-helper","sidebar":"mySidebar"},{"id":"migrating-from-docker/using-the-docker_host-environment-variable","path":"/docs/migrating-from-docker/using-the-docker_host-environment-variable","sidebar":"mySidebar"},{"id":"migrating-from-docker/verifying-your-tools-are-using-podman","path":"/docs/migrating-from-docker/verifying-your-tools-are-using-podman","sidebar":"mySidebar"},{"id":"minikube/building-an-image-and-testing-it-in-minikube","path":"/docs/minikube/building-an-image-and-testing-it-in-minikube","sidebar":"mySidebar"},{"id":"minikube/configuring-podman-for-minikube-on-windows","path":"/docs/minikube/configuring-podman-for-minikube-on-windows","sidebar":"mySidebar"},{"id":"minikube/creating-a-minikube-cluster","path":"/docs/minikube/creating-a-minikube-cluster","sidebar":"mySidebar"},{"id":"minikube/deleting-your-minikube-cluster","path":"/docs/minikube/deleting-your-minikube-cluster","sidebar":"mySidebar"},{"id":"minikube/index","path":"/docs/minikube/","sidebar":"mySidebar"},{"id":"minikube/installing","path":"/docs/minikube/installing","sidebar":"mySidebar"},{"id":"minikube/pushing-an-image-to-minikube","path":"/docs/minikube/pushing-an-image-to-minikube","sidebar":"mySidebar"},{"id":"minikube/restarting-your-minikube-cluster","path":"/docs/minikube/restarting-your-minikube-cluster","sidebar":"mySidebar"},{"id":"minikube/working-with-your-local-minikube-cluster","path":"/docs/minikube/working-with-your-local-minikube-cluster","sidebar":"mySidebar"},{"id":"openshift/developer-sandbox/index","path":"/docs/openshift/developer-sandbox/","sidebar":"mySidebar"},{"id":"openshift/index","path":"/docs/openshift/","sidebar":"mySidebar"},{"id":"openshift/openshift-local/index","path":"/docs/openshift/openshift-local/","sidebar":"mySidebar"},{"id":"podman/accessing-podman-from-another-wsl-instance","path":"/docs/podman/accessing-podman-from-another-wsl-instance","sidebar":"mySidebar"},{"id":"podman/creating-a-podman-machine","path":"/docs/podman/creating-a-podman-machine","sidebar":"mySidebar"},{"id":"podman/index","path":"/docs/podman/","sidebar":"mySidebar"},{"id":"podman/setting-podman-machine-default-connection","path":"/docs/podman/setting-podman-machine-default-connection","sidebar":"mySidebar"},{"id":"proxy/index","path":"/docs/proxy/","sidebar":"mySidebar"},{"id":"troubleshooting/index","path":"/docs/troubleshooting/","sidebar":"mySidebar"},{"id":"troubleshooting/troubleshooting-openshift-local","path":"/docs/troubleshooting/troubleshooting-openshift-local","sidebar":"mySidebar"},{"id":"troubleshooting/troubleshooting-podman","path":"/docs/troubleshooting/troubleshooting-podman","sidebar":"mySidebar"},{"id":"troubleshooting/troubleshooting-podman-on-linux","path":"/docs/troubleshooting/troubleshooting-podman-on-linux","sidebar":"mySidebar"},{"id":"troubleshooting/troubleshooting-podman-on-macos","path":"/docs/troubleshooting/troubleshooting-podman-on-macos","sidebar":"mySidebar"},{"id":"troubleshooting/troubleshooting-podman-on-windows","path":"/docs/troubleshooting/troubleshooting-podman-on-windows","sidebar":"mySidebar"}],"draftIds":[],"sidebars":{"mySidebar":{"link":{"path":"/docs/intro","label":"intro"}}}}],"breadcrumbs":true},"api":{"path":"/api","versions":[{"name":"current","label":"Next","isLast":true,"path":"/api","mainDocId":"index","docs":[{"id":"classes/CancellationTokenSource","path":"/api/classes/CancellationTokenSource","sidebar":"typedocSidebar"},{"id":"classes/Disposable","path":"/api/classes/Disposable","sidebar":"typedocSidebar"},{"id":"classes/EventEmitter","path":"/api/classes/EventEmitter","sidebar":"typedocSidebar"},{"id":"classes/TelemetryTrustedValue","path":"/api/classes/TelemetryTrustedValue","sidebar":"typedocSidebar"},{"id":"classes/Uri","path":"/api/classes/Uri","sidebar":"typedocSidebar"},{"id":"enumerations/InputBoxValidationSeverity","path":"/api/enumerations/InputBoxValidationSeverity","sidebar":"typedocSidebar"},{"id":"enumerations/ProgressLocation","path":"/api/enumerations/ProgressLocation","sidebar":"typedocSidebar"},{"id":"enumerations/QuickPickItemKind","path":"/api/enumerations/QuickPickItemKind","sidebar":"typedocSidebar"},{"id":"index","path":"/api/","sidebar":"typedocSidebar"},{"id":"interfaces/Auditor","path":"/api/interfaces/Auditor","sidebar":"typedocSidebar"},{"id":"interfaces/AuditRecord","path":"/api/interfaces/AuditRecord","sidebar":"typedocSidebar"},{"id":"interfaces/AuditRequestItems","path":"/api/interfaces/AuditRequestItems","sidebar":"typedocSidebar"},{"id":"interfaces/AuditResult","path":"/api/interfaces/AuditResult","sidebar":"typedocSidebar"},{"id":"interfaces/AuthConfig","path":"/api/interfaces/AuthConfig","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationGetSessionOptions","path":"/api/interfaces/AuthenticationGetSessionOptions","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationProvider","path":"/api/interfaces/AuthenticationProvider","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent","path":"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationProviderInformation","path":"/api/interfaces/AuthenticationProviderInformation","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationProviderOptions","path":"/api/interfaces/AuthenticationProviderOptions","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationSession","path":"/api/interfaces/AuthenticationSession","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationSessionAccountInformation","path":"/api/interfaces/AuthenticationSessionAccountInformation","sidebar":"typedocSidebar"},{"id":"interfaces/AuthenticationSessionsChangeEvent","path":"/api/interfaces/AuthenticationSessionsChangeEvent","sidebar":"typedocSidebar"},{"id":"interfaces/BlkioStatEntry","path":"/api/interfaces/BlkioStatEntry","sidebar":"typedocSidebar"},{"id":"interfaces/BlkioStats","path":"/api/interfaces/BlkioStats","sidebar":"typedocSidebar"},{"id":"interfaces/BuildImageOptions","path":"/api/interfaces/BuildImageOptions","sidebar":"typedocSidebar"},{"id":"interfaces/CancellationToken","path":"/api/interfaces/CancellationToken","sidebar":"typedocSidebar"},{"id":"interfaces/CheckResult","path":"/api/interfaces/CheckResult","sidebar":"typedocSidebar"},{"id":"interfaces/CheckResultFixCommand","path":"/api/interfaces/CheckResultFixCommand","sidebar":"typedocSidebar"},{"id":"interfaces/Clipboard","path":"/api/interfaces/Clipboard","sidebar":"typedocSidebar"},{"id":"interfaces/CliTool","path":"/api/interfaces/CliTool","sidebar":"typedocSidebar"},{"id":"interfaces/CliToolOptions","path":"/api/interfaces/CliToolOptions","sidebar":"typedocSidebar"},{"id":"interfaces/CliToolUpdate","path":"/api/interfaces/CliToolUpdate","sidebar":"typedocSidebar"},{"id":"interfaces/CliToolUpdateOptions","path":"/api/interfaces/CliToolUpdateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/Command","path":"/api/interfaces/Command","sidebar":"typedocSidebar"},{"id":"interfaces/Configuration","path":"/api/interfaces/Configuration","sidebar":"typedocSidebar"},{"id":"interfaces/ConfigurationChangeEvent","path":"/api/interfaces/ConfigurationChangeEvent","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerAuthInfo","path":"/api/interfaces/ContainerAuthInfo","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerCreateOptions","path":"/api/interfaces/ContainerCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerCreateResult","path":"/api/interfaces/ContainerCreateResult","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerEngineInfo","path":"/api/interfaces/ContainerEngineInfo","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerInfo","path":"/api/interfaces/ContainerInfo","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerInspectInfo","path":"/api/interfaces/ContainerInspectInfo","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerJSONEvent","path":"/api/interfaces/ContainerJSONEvent","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerProviderConnection","path":"/api/interfaces/ContainerProviderConnection","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerProviderConnectionEndpoint","path":"/api/interfaces/ContainerProviderConnectionEndpoint","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerProviderConnectionFactory","path":"/api/interfaces/ContainerProviderConnectionFactory","sidebar":"typedocSidebar"},{"id":"interfaces/ContainerStatsInfo","path":"/api/interfaces/ContainerStatsInfo","sidebar":"typedocSidebar"},{"id":"interfaces/CPUStats","path":"/api/interfaces/CPUStats","sidebar":"typedocSidebar"},{"id":"interfaces/CPUUsage","path":"/api/interfaces/CPUUsage","sidebar":"typedocSidebar"},{"id":"interfaces/CustomPick","path":"/api/interfaces/CustomPick","sidebar":"typedocSidebar"},{"id":"interfaces/CustomPickItem","path":"/api/interfaces/CustomPickItem","sidebar":"typedocSidebar"},{"id":"interfaces/CustomPickSectionItem","path":"/api/interfaces/CustomPickSectionItem","sidebar":"typedocSidebar"},{"id":"interfaces/DeviceRequest","path":"/api/interfaces/DeviceRequest","sidebar":"typedocSidebar"},{"id":"interfaces/EndpointIPAMConfig","path":"/api/interfaces/EndpointIPAMConfig","sidebar":"typedocSidebar"},{"id":"interfaces/EndpointSettings","path":"/api/interfaces/EndpointSettings","sidebar":"typedocSidebar"},{"id":"interfaces/Event","path":"/api/interfaces/Event","sidebar":"typedocSidebar"},{"id":"interfaces/Extension","path":"/api/interfaces/Extension","sidebar":"typedocSidebar"},{"id":"interfaces/ExtensionContext","path":"/api/interfaces/ExtensionContext","sidebar":"typedocSidebar"},{"id":"interfaces/FileSystemWatcher","path":"/api/interfaces/FileSystemWatcher","sidebar":"typedocSidebar"},{"id":"interfaces/GenerateKubeResult","path":"/api/interfaces/GenerateKubeResult","sidebar":"typedocSidebar"},{"id":"interfaces/HealthCheckLog","path":"/api/interfaces/HealthCheckLog","sidebar":"typedocSidebar"},{"id":"interfaces/HealthCheckResults","path":"/api/interfaces/HealthCheckResults","sidebar":"typedocSidebar"},{"id":"interfaces/HealthConfig","path":"/api/interfaces/HealthConfig","sidebar":"typedocSidebar"},{"id":"interfaces/HostConfig","path":"/api/interfaces/HostConfig","sidebar":"typedocSidebar"},{"id":"interfaces/HostRestartPolicy","path":"/api/interfaces/HostRestartPolicy","sidebar":"typedocSidebar"},{"id":"interfaces/ImageCheck","path":"/api/interfaces/ImageCheck","sidebar":"typedocSidebar"},{"id":"interfaces/ImageCheckerProvider","path":"/api/interfaces/ImageCheckerProvider","sidebar":"typedocSidebar"},{"id":"interfaces/ImageCheckerProviderMetadata","path":"/api/interfaces/ImageCheckerProviderMetadata","sidebar":"typedocSidebar"},{"id":"interfaces/ImageChecks","path":"/api/interfaces/ImageChecks","sidebar":"typedocSidebar"},{"id":"interfaces/ImageInfo","path":"/api/interfaces/ImageInfo","sidebar":"typedocSidebar"},{"id":"interfaces/ImageInspectInfo","path":"/api/interfaces/ImageInspectInfo","sidebar":"typedocSidebar"},{"id":"interfaces/InputBoxOptions","path":"/api/interfaces/InputBoxOptions","sidebar":"typedocSidebar"},{"id":"interfaces/InputBoxValidationMessage","path":"/api/interfaces/InputBoxValidationMessage","sidebar":"typedocSidebar"},{"id":"interfaces/InstallCheck","path":"/api/interfaces/InstallCheck","sidebar":"typedocSidebar"},{"id":"interfaces/IPAM","path":"/api/interfaces/IPAM","sidebar":"typedocSidebar"},{"id":"interfaces/KubeconfigUpdateEvent","path":"/api/interfaces/KubeconfigUpdateEvent","sidebar":"typedocSidebar"},{"id":"interfaces/KubernetesGeneratorProvider","path":"/api/interfaces/KubernetesGeneratorProvider","sidebar":"typedocSidebar"},{"id":"interfaces/KubernetesProviderConnection","path":"/api/interfaces/KubernetesProviderConnection","sidebar":"typedocSidebar"},{"id":"interfaces/KubernetesProviderConnectionEndpoint","path":"/api/interfaces/KubernetesProviderConnectionEndpoint","sidebar":"typedocSidebar"},{"id":"interfaces/KubernetesProviderConnectionFactory","path":"/api/interfaces/KubernetesProviderConnectionFactory","sidebar":"typedocSidebar"},{"id":"interfaces/LifecycleContext","path":"/api/interfaces/LifecycleContext","sidebar":"typedocSidebar"},{"id":"interfaces/Link","path":"/api/interfaces/Link","sidebar":"typedocSidebar"},{"id":"interfaces/ListImagesOptions","path":"/api/interfaces/ListImagesOptions","sidebar":"typedocSidebar"},{"id":"interfaces/ListInfosOptions","path":"/api/interfaces/ListInfosOptions","sidebar":"typedocSidebar"},{"id":"interfaces/Logger","path":"/api/interfaces/Logger","sidebar":"typedocSidebar"},{"id":"interfaces/ManifestCreateOptions","path":"/api/interfaces/ManifestCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/ManifestInspectInfo","path":"/api/interfaces/ManifestInspectInfo","sidebar":"typedocSidebar"},{"id":"interfaces/MemoryStats","path":"/api/interfaces/MemoryStats","sidebar":"typedocSidebar"},{"id":"interfaces/MenuItem","path":"/api/interfaces/MenuItem","sidebar":"typedocSidebar"},{"id":"interfaces/MountSettings","path":"/api/interfaces/MountSettings","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkContainer","path":"/api/interfaces/NetworkContainer","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkCreateOptions","path":"/api/interfaces/NetworkCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkCreateResult","path":"/api/interfaces/NetworkCreateResult","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkInfo","path":"/api/interfaces/NetworkInfo","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkingConfig","path":"/api/interfaces/NetworkingConfig","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkInspectInfo","path":"/api/interfaces/NetworkInspectInfo","sidebar":"typedocSidebar"},{"id":"interfaces/NetworkStats","path":"/api/interfaces/NetworkStats","sidebar":"typedocSidebar"},{"id":"interfaces/NotificationOptions","path":"/api/interfaces/NotificationOptions","sidebar":"typedocSidebar"},{"id":"interfaces/OpenDialogOptions","path":"/api/interfaces/OpenDialogOptions","sidebar":"typedocSidebar"},{"id":"interfaces/PidsStats","path":"/api/interfaces/PidsStats","sidebar":"typedocSidebar"},{"id":"interfaces/PodContainerInfo","path":"/api/interfaces/PodContainerInfo","sidebar":"typedocSidebar"},{"id":"interfaces/PodCreateOptions","path":"/api/interfaces/PodCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/PodCreatePortOptions","path":"/api/interfaces/PodCreatePortOptions","sidebar":"typedocSidebar"},{"id":"interfaces/PodInfo","path":"/api/interfaces/PodInfo","sidebar":"typedocSidebar"},{"id":"interfaces/PodmanContainerCreateOptions","path":"/api/interfaces/PodmanContainerCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/Port","path":"/api/interfaces/Port","sidebar":"typedocSidebar"},{"id":"interfaces/PortBinding","path":"/api/interfaces/PortBinding","sidebar":"typedocSidebar"},{"id":"interfaces/PortMap","path":"/api/interfaces/PortMap","sidebar":"typedocSidebar"},{"id":"interfaces/Progress","path":"/api/interfaces/Progress","sidebar":"typedocSidebar"},{"id":"interfaces/ProgressOptions","path":"/api/interfaces/ProgressOptions","sidebar":"typedocSidebar"},{"id":"interfaces/Provider","path":"/api/interfaces/Provider","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderAutostart","path":"/api/interfaces/ProviderAutostart","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderCleanup","path":"/api/interfaces/ProviderCleanup","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderCleanupAction","path":"/api/interfaces/ProviderCleanupAction","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderCleanupExecuteOptions","path":"/api/interfaces/ProviderCleanupExecuteOptions","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderConnectionFactory","path":"/api/interfaces/ProviderConnectionFactory","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderConnectionLifecycle","path":"/api/interfaces/ProviderConnectionLifecycle","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderContainerConnection","path":"/api/interfaces/ProviderContainerConnection","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderDetectionCheck","path":"/api/interfaces/ProviderDetectionCheck","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderEvent","path":"/api/interfaces/ProviderEvent","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderImages","path":"/api/interfaces/ProviderImages","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderInformation","path":"/api/interfaces/ProviderInformation","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderInstallation","path":"/api/interfaces/ProviderInstallation","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderLifecycle","path":"/api/interfaces/ProviderLifecycle","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderOptions","path":"/api/interfaces/ProviderOptions","sidebar":"typedocSidebar"},{"id":"interfaces/ProviderUpdate","path":"/api/interfaces/ProviderUpdate","sidebar":"typedocSidebar"},{"id":"interfaces/ProxySettings","path":"/api/interfaces/ProxySettings","sidebar":"typedocSidebar"},{"id":"interfaces/PullEvent","path":"/api/interfaces/PullEvent","sidebar":"typedocSidebar"},{"id":"interfaces/QuickInputButton","path":"/api/interfaces/QuickInputButton","sidebar":"typedocSidebar"},{"id":"interfaces/QuickPickItem","path":"/api/interfaces/QuickPickItem","sidebar":"typedocSidebar"},{"id":"interfaces/QuickPickOptions","path":"/api/interfaces/QuickPickOptions","sidebar":"typedocSidebar"},{"id":"interfaces/RegisterContainerConnectionEvent","path":"/api/interfaces/RegisterContainerConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/RegisterKubernetesConnectionEvent","path":"/api/interfaces/RegisterKubernetesConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/Registry","path":"/api/interfaces/Registry","sidebar":"typedocSidebar"},{"id":"interfaces/RegistryConfig","path":"/api/interfaces/RegistryConfig","sidebar":"typedocSidebar"},{"id":"interfaces/RegistryCreateOptions","path":"/api/interfaces/RegistryCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/RegistryProvider","path":"/api/interfaces/RegistryProvider","sidebar":"typedocSidebar"},{"id":"interfaces/RegistrySuggestedProvider","path":"/api/interfaces/RegistrySuggestedProvider","sidebar":"typedocSidebar"},{"id":"interfaces/RunError","path":"/api/interfaces/RunError","sidebar":"typedocSidebar"},{"id":"interfaces/RunOptions","path":"/api/interfaces/RunOptions","sidebar":"typedocSidebar"},{"id":"interfaces/RunResult","path":"/api/interfaces/RunResult","sidebar":"typedocSidebar"},{"id":"interfaces/SaveDialogOptions","path":"/api/interfaces/SaveDialogOptions","sidebar":"typedocSidebar"},{"id":"interfaces/SecretStorage","path":"/api/interfaces/SecretStorage","sidebar":"typedocSidebar"},{"id":"interfaces/SecretStorageChangeEvent","path":"/api/interfaces/SecretStorageChangeEvent","sidebar":"typedocSidebar"},{"id":"interfaces/StatusBarItem","path":"/api/interfaces/StatusBarItem","sidebar":"typedocSidebar"},{"id":"interfaces/StorageStats","path":"/api/interfaces/StorageStats","sidebar":"typedocSidebar"},{"id":"interfaces/TelemetryLogger","path":"/api/interfaces/TelemetryLogger","sidebar":"typedocSidebar"},{"id":"interfaces/TelemetryLoggerOptions","path":"/api/interfaces/TelemetryLoggerOptions","sidebar":"typedocSidebar"},{"id":"interfaces/TelemetrySender","path":"/api/interfaces/TelemetrySender","sidebar":"typedocSidebar"},{"id":"interfaces/ThrottlingData","path":"/api/interfaces/ThrottlingData","sidebar":"typedocSidebar"},{"id":"interfaces/UnregisterContainerConnectionEvent","path":"/api/interfaces/UnregisterContainerConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/UnregisterKubernetesConnectionEvent","path":"/api/interfaces/UnregisterKubernetesConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/UpdateContainerConnectionEvent","path":"/api/interfaces/UpdateContainerConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/UpdateKubernetesConnectionEvent","path":"/api/interfaces/UpdateKubernetesConnectionEvent","sidebar":"typedocSidebar"},{"id":"interfaces/VolumeCreateOptions","path":"/api/interfaces/VolumeCreateOptions","sidebar":"typedocSidebar"},{"id":"interfaces/VolumeCreateResponseInfo","path":"/api/interfaces/VolumeCreateResponseInfo","sidebar":"typedocSidebar"},{"id":"interfaces/VolumeDeleteOptions","path":"/api/interfaces/VolumeDeleteOptions","sidebar":"typedocSidebar"},{"id":"interfaces/VolumeInfo","path":"/api/interfaces/VolumeInfo","sidebar":"typedocSidebar"},{"id":"interfaces/VolumeListInfo","path":"/api/interfaces/VolumeListInfo","sidebar":"typedocSidebar"},{"id":"interfaces/Webview","path":"/api/interfaces/Webview","sidebar":"typedocSidebar"},{"id":"interfaces/WebviewInfo","path":"/api/interfaces/WebviewInfo","sidebar":"typedocSidebar"},{"id":"interfaces/WebviewOptions","path":"/api/interfaces/WebviewOptions","sidebar":"typedocSidebar"},{"id":"interfaces/WebviewPanel","path":"/api/interfaces/WebviewPanel","sidebar":"typedocSidebar"},{"id":"interfaces/WebviewPanelOnDidChangeViewStateEvent","path":"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent","sidebar":"typedocSidebar"},{"id":"namespaces/authentication/functions/getSession","path":"/api/namespaces/authentication/functions/getSession","sidebar":"typedocSidebar"},{"id":"namespaces/authentication/functions/onDidChangeSessions","path":"/api/namespaces/authentication/functions/onDidChangeSessions","sidebar":"typedocSidebar"},{"id":"namespaces/authentication/functions/registerAuthenticationProvider","path":"/api/namespaces/authentication/functions/registerAuthenticationProvider","sidebar":"typedocSidebar"},{"id":"namespaces/authentication/index","path":"/api/namespaces/authentication/","sidebar":"typedocSidebar"},{"id":"namespaces/cli/functions/createCliTool","path":"/api/namespaces/cli/functions/createCliTool","sidebar":"typedocSidebar"},{"id":"namespaces/cli/index","path":"/api/namespaces/cli/","sidebar":"typedocSidebar"},{"id":"namespaces/commands/functions/executeCommand","path":"/api/namespaces/commands/functions/executeCommand","sidebar":"typedocSidebar"},{"id":"namespaces/commands/functions/registerCommand","path":"/api/namespaces/commands/functions/registerCommand","sidebar":"typedocSidebar"},{"id":"namespaces/commands/index","path":"/api/namespaces/commands/","sidebar":"typedocSidebar"},{"id":"namespaces/configuration/functions/getConfiguration","path":"/api/namespaces/configuration/functions/getConfiguration","sidebar":"typedocSidebar"},{"id":"namespaces/configuration/functions/onDidChangeConfiguration","path":"/api/namespaces/configuration/functions/onDidChangeConfiguration","sidebar":"typedocSidebar"},{"id":"namespaces/configuration/index","path":"/api/namespaces/configuration/","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/buildImage","path":"/api/namespaces/containerEngine/functions/buildImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/createContainer","path":"/api/namespaces/containerEngine/functions/createContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/createManifest","path":"/api/namespaces/containerEngine/functions/createManifest","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/createNetwork","path":"/api/namespaces/containerEngine/functions/createNetwork","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/createPod","path":"/api/namespaces/containerEngine/functions/createPod","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/createVolume","path":"/api/namespaces/containerEngine/functions/createVolume","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/deleteContainer","path":"/api/namespaces/containerEngine/functions/deleteContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/deleteImage","path":"/api/namespaces/containerEngine/functions/deleteImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/deleteVolume","path":"/api/namespaces/containerEngine/functions/deleteVolume","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/getImageInspect","path":"/api/namespaces/containerEngine/functions/getImageInspect","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/info","path":"/api/namespaces/containerEngine/functions/info","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/inspectContainer","path":"/api/namespaces/containerEngine/functions/inspectContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/inspectManifest","path":"/api/namespaces/containerEngine/functions/inspectManifest","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listContainers","path":"/api/namespaces/containerEngine/functions/listContainers","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listImages","path":"/api/namespaces/containerEngine/functions/listImages","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listInfos","path":"/api/namespaces/containerEngine/functions/listInfos","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listNetworks","path":"/api/namespaces/containerEngine/functions/listNetworks","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listPods","path":"/api/namespaces/containerEngine/functions/listPods","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/listVolumes","path":"/api/namespaces/containerEngine/functions/listVolumes","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/logsContainer","path":"/api/namespaces/containerEngine/functions/logsContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/onEvent","path":"/api/namespaces/containerEngine/functions/onEvent","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/pullImage","path":"/api/namespaces/containerEngine/functions/pullImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/pushImage","path":"/api/namespaces/containerEngine/functions/pushImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/removePod","path":"/api/namespaces/containerEngine/functions/removePod","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/replicatePodmanContainer","path":"/api/namespaces/containerEngine/functions/replicatePodmanContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/saveImage","path":"/api/namespaces/containerEngine/functions/saveImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/startContainer","path":"/api/namespaces/containerEngine/functions/startContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/startPod","path":"/api/namespaces/containerEngine/functions/startPod","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/statsContainer","path":"/api/namespaces/containerEngine/functions/statsContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/stopContainer","path":"/api/namespaces/containerEngine/functions/stopContainer","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/stopPod","path":"/api/namespaces/containerEngine/functions/stopPod","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/functions/tagImage","path":"/api/namespaces/containerEngine/functions/tagImage","sidebar":"typedocSidebar"},{"id":"namespaces/containerEngine/index","path":"/api/namespaces/containerEngine/","sidebar":"typedocSidebar"},{"id":"namespaces/context/functions/setValue","path":"/api/namespaces/context/functions/setValue","sidebar":"typedocSidebar"},{"id":"namespaces/context/index","path":"/api/namespaces/context/","sidebar":"typedocSidebar"},{"id":"namespaces/env/functions/createTelemetryLogger","path":"/api/namespaces/env/functions/createTelemetryLogger","sidebar":"typedocSidebar"},{"id":"namespaces/env/functions/onDidChangeTelemetryEnabled","path":"/api/namespaces/env/functions/onDidChangeTelemetryEnabled","sidebar":"typedocSidebar"},{"id":"namespaces/env/functions/openExternal","path":"/api/namespaces/env/functions/openExternal","sidebar":"typedocSidebar"},{"id":"namespaces/env/index","path":"/api/namespaces/env/","sidebar":"typedocSidebar"},{"id":"namespaces/env/variables/clipboard","path":"/api/namespaces/env/variables/clipboard","sidebar":"typedocSidebar"},{"id":"namespaces/env/variables/isLinux","path":"/api/namespaces/env/variables/isLinux","sidebar":"typedocSidebar"},{"id":"namespaces/env/variables/isMac","path":"/api/namespaces/env/variables/isMac","sidebar":"typedocSidebar"},{"id":"namespaces/env/variables/isTelemetryEnabled","path":"/api/namespaces/env/variables/isTelemetryEnabled","sidebar":"typedocSidebar"},{"id":"namespaces/env/variables/isWindows","path":"/api/namespaces/env/variables/isWindows","sidebar":"typedocSidebar"},{"id":"namespaces/extensions/functions/getExtension","path":"/api/namespaces/extensions/functions/getExtension","sidebar":"typedocSidebar"},{"id":"namespaces/extensions/functions/onDidChange","path":"/api/namespaces/extensions/functions/onDidChange","sidebar":"typedocSidebar"},{"id":"namespaces/extensions/index","path":"/api/namespaces/extensions/","sidebar":"typedocSidebar"},{"id":"namespaces/extensions/variables/all","path":"/api/namespaces/extensions/variables/all","sidebar":"typedocSidebar"},{"id":"namespaces/fs/functions/createFileSystemWatcher","path":"/api/namespaces/fs/functions/createFileSystemWatcher","sidebar":"typedocSidebar"},{"id":"namespaces/fs/index","path":"/api/namespaces/fs/","sidebar":"typedocSidebar"},{"id":"namespaces/imageChecker/functions/registerImageCheckerProvider","path":"/api/namespaces/imageChecker/functions/registerImageCheckerProvider","sidebar":"typedocSidebar"},{"id":"namespaces/imageChecker/index","path":"/api/namespaces/imageChecker/","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/functions/createResources","path":"/api/namespaces/kubernetes/functions/createResources","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/functions/getKubeconfig","path":"/api/namespaces/kubernetes/functions/getKubeconfig","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/functions/onDidUpdateKubeconfig","path":"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/functions/registerKubernetesGenerator","path":"/api/namespaces/kubernetes/functions/registerKubernetesGenerator","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/functions/setKubeconfig","path":"/api/namespaces/kubernetes/functions/setKubeconfig","sidebar":"typedocSidebar"},{"id":"namespaces/kubernetes/index","path":"/api/namespaces/kubernetes/","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToAuthentication","path":"/api/namespaces/navigation/functions/navigateToAuthentication","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContainer","path":"/api/namespaces/navigation/functions/navigateToContainer","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContainerInspect","path":"/api/namespaces/navigation/functions/navigateToContainerInspect","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContainerLogs","path":"/api/namespaces/navigation/functions/navigateToContainerLogs","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContainers","path":"/api/namespaces/navigation/functions/navigateToContainers","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContainerTerminal","path":"/api/namespaces/navigation/functions/navigateToContainerTerminal","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToContribution","path":"/api/namespaces/navigation/functions/navigateToContribution","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToEditProviderContainerConnection","path":"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToImage","path":"/api/namespaces/navigation/functions/navigateToImage","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToImages","path":"/api/namespaces/navigation/functions/navigateToImages","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToPod","path":"/api/namespaces/navigation/functions/navigateToPod","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToPods","path":"/api/namespaces/navigation/functions/navigateToPods","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToResources","path":"/api/namespaces/navigation/functions/navigateToResources","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToVolume","path":"/api/namespaces/navigation/functions/navigateToVolume","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToVolumes","path":"/api/namespaces/navigation/functions/navigateToVolumes","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/functions/navigateToWebview","path":"/api/namespaces/navigation/functions/navigateToWebview","sidebar":"typedocSidebar"},{"id":"namespaces/navigation/index","path":"/api/namespaces/navigation/","sidebar":"typedocSidebar"},{"id":"namespaces/process/functions/exec","path":"/api/namespaces/process/functions/exec","sidebar":"typedocSidebar"},{"id":"namespaces/process/index","path":"/api/namespaces/process/","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/createProvider","path":"/api/namespaces/provider/functions/createProvider","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/getContainerConnections","path":"/api/namespaces/provider/functions/getContainerConnections","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/getProviderLifecycleContext","path":"/api/namespaces/provider/functions/getProviderLifecycleContext","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/onDidRegisterContainerConnection","path":"/api/namespaces/provider/functions/onDidRegisterContainerConnection","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/onDidUnregisterContainerConnection","path":"/api/namespaces/provider/functions/onDidUnregisterContainerConnection","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/onDidUpdateContainerConnection","path":"/api/namespaces/provider/functions/onDidUpdateContainerConnection","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/onDidUpdateKubernetesConnection","path":"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection","sidebar":"typedocSidebar"},{"id":"namespaces/provider/functions/onDidUpdateProvider","path":"/api/namespaces/provider/functions/onDidUpdateProvider","sidebar":"typedocSidebar"},{"id":"namespaces/provider/index","path":"/api/namespaces/provider/","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/functions/getProxySettings","path":"/api/namespaces/proxy/functions/getProxySettings","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/functions/isEnabled","path":"/api/namespaces/proxy/functions/isEnabled","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/functions/onDidStateChange","path":"/api/namespaces/proxy/functions/onDidStateChange","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/functions/onDidUpdateProxy","path":"/api/namespaces/proxy/functions/onDidUpdateProxy","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/functions/setProxy","path":"/api/namespaces/proxy/functions/setProxy","sidebar":"typedocSidebar"},{"id":"namespaces/proxy/index","path":"/api/namespaces/proxy/","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/onDidRegisterRegistry","path":"/api/namespaces/registry/functions/onDidRegisterRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/onDidUnregisterRegistry","path":"/api/namespaces/registry/functions/onDidUnregisterRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/onDidUpdateRegistry","path":"/api/namespaces/registry/functions/onDidUpdateRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/registerRegistry","path":"/api/namespaces/registry/functions/registerRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/registerRegistryProvider","path":"/api/namespaces/registry/functions/registerRegistryProvider","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/suggestRegistry","path":"/api/namespaces/registry/functions/suggestRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/functions/unregisterRegistry","path":"/api/namespaces/registry/functions/unregisterRegistry","sidebar":"typedocSidebar"},{"id":"namespaces/registry/index","path":"/api/namespaces/registry/","sidebar":"typedocSidebar"},{"id":"namespaces/tray/functions/registerMenuItem","path":"/api/namespaces/tray/functions/registerMenuItem","sidebar":"typedocSidebar"},{"id":"namespaces/tray/functions/registerProviderMenuItem","path":"/api/namespaces/tray/functions/registerProviderMenuItem","sidebar":"typedocSidebar"},{"id":"namespaces/tray/index","path":"/api/namespaces/tray/","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/createCustomPick","path":"/api/namespaces/window/functions/createCustomPick","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/createStatusBarItem","path":"/api/namespaces/window/functions/createStatusBarItem","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/createWebviewPanel","path":"/api/namespaces/window/functions/createWebviewPanel","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/listWebviews","path":"/api/namespaces/window/functions/listWebviews","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showErrorMessage","path":"/api/namespaces/window/functions/showErrorMessage","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showInformationMessage","path":"/api/namespaces/window/functions/showInformationMessage","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showInputBox","path":"/api/namespaces/window/functions/showInputBox","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showNotification","path":"/api/namespaces/window/functions/showNotification","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showOpenDialog","path":"/api/namespaces/window/functions/showOpenDialog","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showQuickPick","path":"/api/namespaces/window/functions/showQuickPick","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showSaveDialog","path":"/api/namespaces/window/functions/showSaveDialog","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/showWarningMessage","path":"/api/namespaces/window/functions/showWarningMessage","sidebar":"typedocSidebar"},{"id":"namespaces/window/functions/withProgress","path":"/api/namespaces/window/functions/withProgress","sidebar":"typedocSidebar"},{"id":"namespaces/window/index","path":"/api/namespaces/window/","sidebar":"typedocSidebar"},{"id":"type-aliases/CheckResultLink","path":"/api/type-aliases/CheckResultLink","sidebar":"typedocSidebar"},{"id":"type-aliases/CliToolState","path":"/api/type-aliases/CliToolState","sidebar":"typedocSidebar"},{"id":"type-aliases/ConfigurationScope","path":"/api/type-aliases/ConfigurationScope","sidebar":"typedocSidebar"},{"id":"type-aliases/KubernetesGeneratorArgument","path":"/api/type-aliases/KubernetesGeneratorArgument","sidebar":"typedocSidebar"},{"id":"type-aliases/KubernetesGeneratorSelector","path":"/api/type-aliases/KubernetesGeneratorSelector","sidebar":"typedocSidebar"},{"id":"type-aliases/KubernetesGeneratorType","path":"/api/type-aliases/KubernetesGeneratorType","sidebar":"typedocSidebar"},{"id":"type-aliases/MountConfig","path":"/api/type-aliases/MountConfig","sidebar":"typedocSidebar"},{"id":"type-aliases/MountConsistency","path":"/api/type-aliases/MountConsistency","sidebar":"typedocSidebar"},{"id":"type-aliases/MountPropagation","path":"/api/type-aliases/MountPropagation","sidebar":"typedocSidebar"},{"id":"type-aliases/MountType","path":"/api/type-aliases/MountType","sidebar":"typedocSidebar"},{"id":"type-aliases/NotificationType","path":"/api/type-aliases/NotificationType","sidebar":"typedocSidebar"},{"id":"type-aliases/ProviderConnectionStatus","path":"/api/type-aliases/ProviderConnectionStatus","sidebar":"typedocSidebar"},{"id":"type-aliases/ProviderLinks","path":"/api/type-aliases/ProviderLinks","sidebar":"typedocSidebar"},{"id":"type-aliases/ProviderResult","path":"/api/type-aliases/ProviderResult","sidebar":"typedocSidebar"},{"id":"type-aliases/ProviderStatus","path":"/api/type-aliases/ProviderStatus","sidebar":"typedocSidebar"},{"id":"type-aliases/StatusBarAlignment","path":"/api/type-aliases/StatusBarAlignment","sidebar":"typedocSidebar"},{"id":"variables/StatusBarAlignLeft","path":"/api/variables/StatusBarAlignLeft","sidebar":"typedocSidebar"},{"id":"variables/StatusBarAlignRight","path":"/api/variables/StatusBarAlignRight","sidebar":"typedocSidebar"},{"id":"variables/StatusBarItemDefaultPriority","path":"/api/variables/StatusBarItemDefaultPriority","sidebar":"typedocSidebar"},{"id":"variables/version","path":"/api/variables/version","sidebar":"typedocSidebar"}],"draftIds":[],"sidebars":{"typedocSidebar":{"link":{"path":"/api/","label":"Podman-Desktop API"}}}}],"breadcrumbs":true}}}'),r=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(57529);const c=JSON.parse('{"docusaurusVersion":"3.4.0","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.4.0"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.4.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.4.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.4.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.4.0"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"3.4.0"},"docusaurus-tailwindcss":{"type":"local"},"docusaurus-plugin-goatcounter":{"type":"package","name":"docusaurus-plugin-goatcounter","version":"3.0.0"},"docusaurus-plugin-client-redirects":{"type":"package","name":"@docusaurus/plugin-client-redirects","version":"3.4.0"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"1.0.1"},"docusaurus-theme-mermaid":{"type":"package","name":"@docusaurus/theme-mermaid","version":"3.4.0"}}}');var l=n(24246);const d={siteConfig:i.default,siteMetadata:c,globalData:o,i18n:r,codeTranslations:s},u=a.createContext(d);function p(e){let{children:t}=e;return(0,l.jsx)(u.Provider,{value:d,children:t})}},46293:(e,t,n)=>{"use strict";n.d(t,{Z:()=>b});var a=n(27378),i=n(161),o=n(7092),r=n(51721),s=n(40684),c=n(66881),l=n(24246);function d(e){let{error:t,tryAgain:n}=e;return(0,l.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,l.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,l.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,l.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,r.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,l.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,l.jsx)(c.z,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,l.jsx)(p,{children:(0,l.jsxs)(b,{fallback:()=>(0,l.jsx)(d,{error:t,tryAgain:n}),children:[(0,l.jsx)(o.Z,{children:(0,l.jsx)("title",{children:"Page Error"})}),(0,l.jsx)(s.Z,{children:(0,l.jsx)(d,{error:t,tryAgain:n})})]})})}const m=e=>(0,l.jsx)(f,{...e});class b extends a.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){i.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},161:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});const a="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,i={canUseDOM:a,canUseEventListeners:a&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:a&&"IntersectionObserver"in window,canUseViewport:a&&"screen"in window}},7092:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(27378);var a=n(92883),i=n(24246);function o(e){return(0,i.jsx)(a.ql,{...e})}},36641:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var a=n(27378),i=n(20988),o=n(51721),r=n(50353),s=n(45626),c=n(161),l=n(41521),d=n(98948),u=n(24246);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:b,"data-noBrokenLinkCheck":g,autoAddBaseUrl:h=!0,...y}=e;const{siteConfig:v}=(0,r.Z)(),{trailingSlash:k,baseUrl:S}=v,x=v.future.experimental_router,{withBaseUrl:w}=(0,d.Cg)(),_=(0,l.Z)(),C=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>C.current));const E=p||f;const P=(0,s.Z)(E),T=E?.replace("pathname://","");let I=void 0!==T?(A=T,h&&(e=>e.startsWith("/"))(A)?w(A):A):void 0;var A;"hash"===x&&I?.startsWith("./")&&(I=I?.slice(1)),I&&P&&(I=(0,o.applyTrailingSlash)(I,{trailingSlash:k,baseUrl:S}));const R=(0,a.useRef)(!1),O=n?i.OL:i.rU,L=c.Z.canUseIntersectionObserver,N=(0,a.useRef)(),j=()=>{R.current||null==I||(window.docusaurus.preload(I),R.current=!0)};(0,a.useEffect)((()=>(!L&&P&&null!=I&&window.docusaurus.prefetch(I),()=>{L&&N.current&&N.current.disconnect()})),[N,I,L,P]);const D=I?.startsWith("#")??!1,M=!y.target||"_self"===y.target,F=!I||!P||!M;return g||!D&&F||_.collectLink(I),y.id&&_.collectAnchor(y.id),F?(0,u.jsx)("a",{ref:C,href:I,...E&&!P&&{target:"_blank",rel:"noopener noreferrer"},...y}):(0,u.jsx)(O,{...y,onMouseEnter:j,onTouchStart:j,innerRef:e=>{C.current=e,L&&e&&P&&(N.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(N.current.unobserve(e),N.current.disconnect(),null!=I&&window.docusaurus.prefetch(I))}))})),N.current.observe(e))},to:I,...n&&{isActive:b,activeClassName:m}})}const f=a.forwardRef(p)},99213:(e,t,n)=>{"use strict";n.d(t,{Z:()=>l,I:()=>c});var a=n(27378),i=n(24246);function o(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,a.isValidElement)(e)))?n.map(((e,t)=>(0,a.isValidElement)(e)?a.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var r=n(57529);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return r[t??n]??n??t}function c(e,t){let{message:n,id:a}=e;return o(s({message:n,id:a}),t)}function l(e){let{children:t,id:n,values:a}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const r=s({message:t,id:n});return(0,i.jsx)(i.Fragment,{children:o(r,a)})}},45688:(e,t,n)=>{"use strict";n.d(t,{m:()=>a});const a="default"},45626:(e,t,n)=>{"use strict";function a(e){return/^(?:\w*:|\/\/)/.test(e)}function i(e){return void 0!==e&&!a(e)}n.d(t,{Z:()=>i,b:()=>a})},98948:(e,t,n)=>{"use strict";n.d(t,{Cg:()=>r,ZP:()=>s});var a=n(27378),i=n(50353),o=n(45626);function r(){const{siteConfig:e}=(0,i.Z)(),{baseUrl:t,url:n}=e,r=e.future.experimental_router,s=(0,a.useCallback)(((e,a)=>function(e){let{siteUrl:t,baseUrl:n,url:a,options:{forcePrependBaseUrl:i=!1,absolute:r=!1}={},router:s}=e;if(!a||a.startsWith("#")||(0,o.b)(a))return a;if("hash"===s)return a.startsWith("/")?`.${a}`:`./${a}`;if(i)return n+a.replace(/^\//,"");if(a===n.replace(/\/$/,""))return n;const c=a.startsWith(n)?a:n+a.replace(/^\//,"");return r?t+c:c}({siteUrl:n,baseUrl:t,url:e,options:a,router:r})),[n,t,r]);return{withBaseUrl:s}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=r();return n(e,t)}},41521:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});var a=n(27378);n(24246);const i=a.createContext({collectAnchor:()=>{},collectLink:()=>{}}),o=()=>(0,a.useContext)(i);function r(){return o()}},50353:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var a=n(27378),i=n(83340);function o(){return(0,a.useContext)(i._)}},76457:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var a=n(27378),i=n(23427);function o(){return(0,a.useContext)(i._)}},9834:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var a=n(27378);const i=n(161).Z.canUseDOM?a.useLayoutEffect:a.useEffect},74909:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var a=n(27378),i=n(66881);function o(){const e=a.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}},13361:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});const a=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function i(e){const t={};return function e(n,i){Object.entries(n).forEach((n=>{let[o,r]=n;const s=i?`${i}.${o}`:o;a(r)?e(r,s):t[s]=r}))}(e),t}},66881:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,z:()=>r});var a=n(27378),i=n(24246);const o=a.createContext(null);function r(e){let{children:t,value:n}=e;const r=a.useContext(o),s=(0,a.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const a={...t.data,...n?.data};return{plugin:t.plugin,data:a}}({parent:r,value:n})),[r,n]);return(0,i.jsx)(o.Provider,{value:s,children:t})}},62935:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>h,gA:()=>f,WS:()=>m,_r:()=>u,Jo:()=>y,zh:()=>p,yW:()=>g,gB:()=>b});var a=n(48165),i=n(50353),o=n(45688);function r(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,i.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find((e=>e.isLast));function c(e,t){const n=s(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,a.LX)(t,{path:e.path,exact:!1,strict:!1})))}function l(e,t){const n=c(e,t),i=n?.docs.find((e=>!!(0,a.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:i,alternateDocVersions:i?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((a=>{a.id===t&&(n[e.name]=a)}))})),n}(i.id):{}}}const d={},u=()=>r("docusaurus-plugin-content-docs")??d,p=e=>{try{return function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const a=r(e),i=a?.[t];if(!i&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return i}("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function f(e){void 0===e&&(e={});const t=u(),{pathname:n}=(0,a.TH)();return function(e,t,n){void 0===n&&(n={});const i=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,a.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=i?{pluginId:i[0],pluginData:i[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function m(e){void 0===e&&(e={});const t=f(e),{pathname:n}=(0,a.TH)();if(!t)return;return{activePlugin:t,activeVersion:c(t.pluginData,n)}}function b(e){return p(e).versions}function g(e){const t=p(e);return s(t)}function h(e){const t=p(e),{pathname:n}=(0,a.TH)();return l(t,n)}function y(e){const t=p(e),{pathname:n}=(0,a.TH)();return function(e,t){const n=s(e);return{latestDocSuggestion:l(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},54374:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var a=n(8504),i=n.n(a);i().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{i().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){i().done()}}},23815:(e,t,n)=>{"use strict";n.r(t);var a=n(26101),i=n(36809);!function(e){const{themeConfig:{prism:t}}=i.default,{additionalLanguages:a}=t;globalThis.Prism=e,a.forEach((e=>{"php"===e&&n(13109),n(60926)(`./prism-${e}`)})),delete globalThis.Prism}(a.p1)},1999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});n(27378);var a=n(40624),i=n(99213),o=n(20624),r=n(36641),s=n(41521);const c={anchorWithStickyNavbar:"anchorWithStickyNavbar_JmGV",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_pMLv"};var l=n(24246);function d(e){let{as:t,id:n,...d}=e;const u=(0,s.Z)(),{navbar:{hideOnScroll:p}}=(0,o.L)();if("h1"===t||!n)return(0,l.jsx)(t,{...d,id:void 0});u.collectAnchor(n);const f=(0,i.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof d.children?d.children:n});return(0,l.jsxs)(t,{...d,className:(0,a.Z)("anchor",p?c.anchorWithHideOnScrollNavbar:c.anchorWithStickyNavbar,d.className),id:n,children:[d.children,(0,l.jsx)(r.Z,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},6125:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(27378);const a={iconExternalLink:"iconExternalLink_nPrP"};var i=n(24246);function o(e){let{width:t=13.5,height:n=13.5}=e;return(0,i.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:a.iconExternalLink,children:(0,i.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},40684:(e,t,n)=>{"use strict";n.d(t,{Z:()=>Tt});var a=n(27378),i=n(40624),o=n(46293),r=n(88676),s=n(48165),c=n(99213),l=n(24993),d=n(24246);const u="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,a.useRef)(null),{action:t}=(0,s.k6)(),n=(0,a.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(u);t&&p(t)}),[]);return(0,l.S)((n=>{let{location:a}=n;e.current&&!a.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,c.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function b(e){const t=e.children??m,{containerRef:n,onClick:a}=f();return(0,d.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,d.jsx)("a",{...e,href:`#${u}`,onClick:a,children:t})})}var g=n(75484),h=n(70174);const y={skipToContent:"skipToContent_oPtH"};function v(){return(0,d.jsx)(b,{className:y.skipToContent})}var k=n(20624),S=n(10);function x(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:i=1.2,className:o,...r}=e;return(0,d.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...r,children:(0,d.jsx)("g",{stroke:a,strokeWidth:i,children:(0,d.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const w={closeButton:"closeButton_J5rP"};function _(e){return(0,d.jsx)("button",{type:"button","aria-label":(0,c.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,i.Z)("clean-btn close",w.closeButton,e.className),children:(0,d.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_bSb_"};function E(e){const{announcementBar:t}=(0,k.L)(),{content:n}=t;return(0,d.jsx)("div",{...e,className:(0,i.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const P={announcementBar:"announcementBar_zJRd",announcementBarPlaceholder:"announcementBarPlaceholder_NpUd",announcementBarClose:"announcementBarClose_Jjdj",announcementBarContent:"announcementBarContent_t7IR"};function T(){const{announcementBar:e}=(0,k.L)(),{isActive:t,close:n}=(0,S.n)();if(!t)return null;const{backgroundColor:a,textColor:i,isCloseable:o}=e;return(0,d.jsxs)("div",{className:P.announcementBar,style:{backgroundColor:a,color:i},role:"banner",children:[o&&(0,d.jsx)("div",{className:P.announcementBarPlaceholder}),(0,d.jsx)(E,{className:P.announcementBarContent}),o&&(0,d.jsx)(_,{onClick:n,className:P.announcementBarClose})]})}var I=n(85536),A=n(83457);var R=n(41763),O=n(63471);const L=a.createContext(null);function N(e){let{children:t}=e;const n=function(){const e=(0,I.e)(),t=(0,O.HY)(),[n,i]=(0,a.useState)(!1),o=null!==t.component,r=(0,R.D9)(o);return(0,a.useEffect)((()=>{o&&!r&&i(!0)}),[o,r]),(0,a.useEffect)((()=>{o?e.shown||i(!0):i(!1)}),[e.shown,o]),(0,a.useMemo)((()=>[n,i]),[n])}();return(0,d.jsx)(L.Provider,{value:n,children:t})}function j(e){if(e.component){const t=e.component;return(0,d.jsx)(t,{...e.props})}}function D(){const e=(0,a.useContext)(L);if(!e)throw new R.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,i=(0,a.useCallback)((()=>n(!1)),[n]),o=(0,O.HY)();return(0,a.useMemo)((()=>({shown:t,hide:i,content:j(o)})),[i,o,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:a}=e;const{shown:o}=D();return(0,d.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,d.jsxs)("div",{className:(0,i.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,d.jsx)("div",{className:"navbar-sidebar__item menu",children:a})]})]})}var F=n(55421),B=n(76457);function U(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function $(e){return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,d.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const z={toggle:"toggle_ki11",toggleButton:"toggleButton_MMFG",darkToggleIcon:"darkToggleIcon_U96C",lightToggleIcon:"lightToggleIcon_lgto",toggleButtonDisabled:"toggleButtonDisabled_Uw7m"};function H(e){let{className:t,buttonClassName:n,value:a,onChange:o}=e;const r=(0,B.Z)(),s=(0,c.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===a?(0,c.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,c.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,d.jsx)("div",{className:(0,i.Z)(z.toggle,t),children:(0,d.jsxs)("button",{className:(0,i.Z)("clean-btn",z.toggleButton,!r&&z.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===a?"light":"dark"),disabled:!r,title:s,"aria-label":s,"aria-live":"polite",children:[(0,d.jsx)(U,{className:(0,i.Z)(z.toggleIcon,z.lightToggleIcon)}),(0,d.jsx)($,{className:(0,i.Z)(z.toggleIcon,z.darkToggleIcon)})]})})}const V=a.memo(H),W={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_m8pZ"};function Z(e){let{className:t}=e;const n=(0,k.L)().navbar.style,a=(0,k.L)().colorMode.disableSwitch,{colorMode:i,setColorMode:o}=(0,F.I)();return a?null:(0,d.jsx)(V,{className:t,buttonClassName:"dark"===n?W.darkNavbarColorModeToggle:void 0,value:i,onChange:o})}var K=n(10898);function G(){return(0,d.jsx)(K.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function q(){const e=(0,I.e)();return(0,d.jsx)("button",{type:"button","aria-label":(0,c.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,d.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function Q(){return(0,d.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,d.jsx)(G,{}),(0,d.jsx)(Z,{className:"margin-right--md"}),(0,d.jsx)(q,{})]})}var Y=n(36641),X=n(98948),J=n(45626),ee=n(61503),te=n(6125);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:i,label:o,html:r,isDropdownLink:s,prependBaseUrlToHref:c,...l}=e;const u=(0,X.ZP)(a),p=(0,X.ZP)(t),f=(0,X.ZP)(i,{forcePrependBaseUrl:!0}),m=o&&i&&!(0,J.Z)(i),b=r?{dangerouslySetInnerHTML:{__html:r}}:{children:(0,d.jsxs)(d.Fragment,{children:[o,m&&(0,d.jsx)(te.Z,{...s&&{width:12,height:12}})]})};return i?(0,d.jsx)(Y.Z,{href:c?f:i,...l,...b}):(0,d.jsx)(Y.Z,{to:u,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?(0,ee.F)(n,t.pathname):t.pathname.startsWith(p)},...l,...b})}function ae(e){let{className:t,isDropdownItem:n=!1,...a}=e;const o=(0,d.jsx)(ne,{className:(0,i.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...a});return n?(0,d.jsx)("li",{children:o}):o}function ie(e){let{className:t,isDropdownItem:n,...a}=e;return(0,d.jsx)("li",{className:"menu__list-item",children:(0,d.jsx)(ne,{className:(0,i.Z)("menu__link",t),...a})})}function oe(e){let{mobile:t=!1,position:n,...a}=e;const i=t?ie:ae;return(0,d.jsx)(i,{...a,activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var re=n(80376),se=n(8862),ce=n(50353);const le={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_MJ1i"};function de(e,t){return e.some((e=>function(e,t){return!!(0,se.Mg)(e.to,t)||!!(0,ee.F)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function ue(e){let{items:t,position:n,className:o,onClick:r,...s}=e;const c=(0,a.useRef)(null),[l,u]=(0,a.useState)(!1);return(0,a.useEffect)((()=>{const e=e=>{c.current&&!c.current.contains(e.target)&&u(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[c]),(0,d.jsxs)("div",{ref:c,className:(0,i.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":l}),children:[(0,d.jsx)(ne,{"aria-haspopup":"true","aria-expanded":l,role:"button",href:s.to?void 0:"#",className:(0,i.Z)("navbar__link",o),...s,onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),u(!l))},children:s.children??s.label}),(0,d.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,a.createElement)(Ve,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:r,...c}=e;const l=function(){const{siteConfig:{baseUrl:e}}=(0,ce.Z)(),{pathname:t}=(0,s.TH)();return t.replace(e,"/")}(),u=de(t,l),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,re.u)({initialState:()=>!u});return(0,a.useEffect)((()=>{u&&m(!u)}),[l,u,m]),(0,d.jsxs)("li",{className:(0,i.Z)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,d.jsx)(ne,{role:"button",className:(0,i.Z)(le.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...c,onClick:e=>{e.preventDefault(),f()},children:c.children??c.label}),(0,d.jsx)(re.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,a.createElement)(Ve,{mobile:!0,isDropdownItem:!0,onClick:r,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const a=t?pe:ue;return(0,d.jsx)(a,{...n})}var me=n(43714);function be(e){let{width:t=20,height:n=20,...a}=e;return(0,d.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...a,children:(0,d.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_kvP7";var he=n(31542);function ye(){return a.createElement("svg",{width:"15",height:"15",className:"DocSearch-Control-Key-Icon"},a.createElement("path",{d:"M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953",strokeWidth:"1.2",stroke:"currentColor",fill:"none",strokeLinecap:"square"}))}var ve=n(56573),ke=["translations"];function Se(){return Se=Object.assign||function(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var Ce="Ctrl";var Ee=a.forwardRef((function(e,t){var n=e.translations,i=void 0===n?{}:n,o=_e(e,ke),r=i.buttonText,s=void 0===r?"Search":r,c=i.buttonAriaLabel,l=void 0===c?"Search":c,d=xe((0,a.useState)(null),2),u=d[0],p=d[1];return(0,a.useEffect)((function(){"undefined"!=typeof navigator&&(/(Mac|iPhone|iPod|iPad)/i.test(navigator.platform)?p("\u2318"):p(Ce))}),[]),a.createElement("button",Se({type:"button",className:"DocSearch DocSearch-Button","aria-label":l},o,{ref:t}),a.createElement("span",{className:"DocSearch-Button-Container"},a.createElement(ve.W,null),a.createElement("span",{className:"DocSearch-Button-Placeholder"},s)),a.createElement("span",{className:"DocSearch-Button-Keys"},null!==u&&a.createElement(a.Fragment,null,a.createElement("kbd",{className:"DocSearch-Button-Key"},u===Ce?a.createElement(ye,null):u),a.createElement("kbd",{className:"DocSearch-Button-Key"},"K"))))})),Pe=n(7092),Te=n(53584),Ie=n(42473),Ae=n(13149);const Re={button:{buttonText:(0,c.I)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,c.I)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,c.I)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,c.I)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,c.I)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,c.I)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,c.I)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,c.I)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,c.I)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,c.I)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,c.I)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,c.I)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,c.I)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,c.I)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,c.I)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,c.I)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,c.I)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,c.I)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,c.I)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,c.I)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,c.I)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,c.I)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,c.I)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,c.I)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,c.I)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,c.I)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,c.I)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let Oe=null;function Le(e){let{hit:t,children:n}=e;return(0,d.jsx)(Y.Z,{to:t.url,children:n})}function Ne(e){let{state:t,onClose:n}=e;const a=(0,Te.M)();return(0,d.jsx)(Y.Z,{to:a(t.query),onClick:n,children:(0,d.jsx)(c.Z,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits},children:"See all {count} results"})})}function je(e){let{contextualSearch:t,externalUrlRegex:i,...o}=e;const{siteMetadata:r}=(0,ce.Z)(),c=(0,Ie.l)(),l=function(){const{locale:e,tags:t}=(0,Ae._q)();return[`language:${e}`,t.map((e=>`docusaurus_tag:${e}`))]}(),u=o.searchParameters?.facetFilters??[],p=t?function(e,t){const n=e=>"string"==typeof e?[e]:e;return[...n(e),...n(t)]}(l,u):u,f={...o.searchParameters,facetFilters:p},m=(0,s.k6)(),b=(0,a.useRef)(null),g=(0,a.useRef)(null),[h,y]=(0,a.useState)(!1),[v,k]=(0,a.useState)(void 0),S=(0,a.useCallback)((()=>Oe?Promise.resolve():Promise.all([n.e(93041).then(n.bind(n,93041)),Promise.all([n.e(40532),n.e(89127)]).then(n.bind(n,89127)),Promise.all([n.e(40532),n.e(34670)]).then(n.bind(n,34670))]).then((e=>{let[{DocSearchModal:t}]=e;Oe=t}))),[]),x=(0,a.useCallback)((()=>{if(!b.current){const e=document.createElement("div");b.current=e,document.body.insertBefore(e,document.body.firstChild)}}),[]),w=(0,a.useCallback)((()=>{x(),S().then((()=>y(!0)))}),[S,x]),_=(0,a.useCallback)((()=>{y(!1),g.current?.focus()}),[]),C=(0,a.useCallback)((e=>{e.preventDefault(),k(e.key),w()}),[w]),E=(0,a.useRef)({navigate(e){let{itemUrl:t}=e;(0,ee.F)(i,t)?window.location.href=t:m.push(t)}}).current,P=(0,a.useRef)((e=>o.transformItems?o.transformItems(e):e.map((e=>({...e,url:c(e.url)}))))).current,T=(0,a.useMemo)((()=>e=>(0,d.jsx)(Ne,{...e,onClose:_})),[_]),I=(0,a.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",r.docusaurusVersion),e)),[r.docusaurusVersion]);return function(e){var t=e.isOpen,n=e.onOpen,i=e.onClose,o=e.onInput,r=e.searchButtonRef;a.useEffect((function(){function e(e){var a;(27===e.keyCode&&t||"k"===(null===(a=e.key)||void 0===a?void 0:a.toLowerCase())&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,n=t.tagName;return t.isContentEditable||"INPUT"===n||"SELECT"===n||"TEXTAREA"===n}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?i():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||n()),r&&r.current===document.activeElement&&o&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&o(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,n,i,o,r])}({isOpen:h,onOpen:w,onClose:_,onInput:C,searchButtonRef:g}),(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(Pe.Z,{children:(0,d.jsx)("link",{rel:"preconnect",href:`https://${o.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})}),(0,d.jsx)(Ee,{onTouchStart:S,onFocus:S,onMouseOver:S,onClick:w,ref:g,translations:Re.button}),h&&Oe&&b.current&&(0,he.createPortal)((0,d.jsx)(Oe,{onClose:_,initialScrollY:window.scrollY,initialQuery:v,navigator:E,transformItems:P,hitComponent:Le,transformSearchClient:I,...o.searchPagePath&&{resultsFooterComponent:T},...o,searchParameters:f,placeholder:Re.placeholder,translations:Re.modal}),b.current)]})}function De(){const{siteConfig:e}=(0,ce.Z)();return(0,d.jsx)(je,{...e.themeConfig.algolia})}const Me={navbarSearchContainer:"navbarSearchContainer_bzqh"};function Fe(e){let{children:t,className:n}=e;return(0,d.jsx)("div",{className:(0,i.Z)(n,Me.navbarSearchContainer),children:t})}var Be=n(62935),Ue=n(45161);var $e=n(24453);const ze=e=>e.docs.find((t=>t.id===e.mainDocId));const He={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,queryString:i="",...o}=e;const{i18n:{currentLocale:r,locales:l,localeConfigs:u}}=(0,ce.Z)(),p=(0,me.l)(),{search:f,hash:m}=(0,s.TH)(),b=[...n,...l.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${i}`;return{label:u[e].label,lang:u[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===r?t?"menu__link--active":"dropdown__link--active":""}})),...a],g=t?(0,c.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):u[r].label;return(0,d.jsx)(fe,{...o,mobile:t,label:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(be,{className:ge}),g]}),items:b})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,d.jsx)(Fe,{className:n,children:(0,d.jsx)(De,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:a=!1,isDropdownItem:o=!1}=e;const r=o?"li":"div";return(0,d.jsx)(r,{className:(0,i.Z)({navbar__item:!a&&!o,"menu__list-item":a},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...i}=e;const{activeDoc:o}=(0,Be.Iw)(a),r=(0,Ue.vY)(t,a),s=o?.path===r?.path;return null===r||r.unlisted&&!s?null:(0,d.jsx)(oe,{exact:!0,...i,isActive:()=>s||!!o?.sidebar&&o.sidebar===r.sidebar,label:n??r.id,to:r.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...i}=e;const{activeDoc:o}=(0,Be.Iw)(a),r=(0,Ue.oz)(t,a).link;if(!r)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,d.jsx)(oe,{exact:!0,...i,isActive:()=>o?.sidebar===t,label:n??r.label,to:r.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...i}=e;const o=(0,Ue.lO)(a)[0],r=t??o.label,s=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,d.jsx)(oe,{...i,label:r,to:s})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:i,dropdownItemsAfter:o,...r}=e;const{search:l,hash:u}=(0,s.TH)(),p=(0,Be.Iw)(n),f=(0,Be.gB)(n),{savePreferredVersionName:m}=(0,$e.J)(n),b=[...i,...f.map((e=>{const t=p.alternateDocVersions[e.name]??ze(e);return{label:e.label,to:`${t.path}${l}${u}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...o],g=(0,Ue.lO)(n)[0],h=t&&b.length>1?(0,c.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,y=t&&b.length>1?void 0:ze(g).path;return b.length<=1?(0,d.jsx)(oe,{...r,mobile:t,label:h,to:y,isActive:a?()=>!1:void 0}):(0,d.jsx)(fe,{...r,mobile:t,label:h,to:y,items:b,isActive:a?()=>!1:void 0})}};function Ve(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),i=He[a];if(!i)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,d.jsx)(i,{...n})}function We(){const e=(0,I.e)(),t=(0,k.L)().navbar.items;return(0,d.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,a.createElement)(Ve,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Ze(e){return(0,d.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,d.jsx)(c.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Ke(){const e=0===(0,k.L)().navbar.items.length,t=D();return(0,d.jsxs)(d.Fragment,{children:[!e&&(0,d.jsx)(Ze,{onClick:()=>t.hide()}),t.content]})}function Ge(){const e=(0,I.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,a.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,d.jsx)(M,{header:(0,d.jsx)(Q,{}),primaryMenu:(0,d.jsx)(We,{}),secondaryMenu:(0,d.jsx)(Ke,{})}):null}const qe={navbarHideable:"navbarHideable_hhpl",navbarHidden:"navbarHidden_nmcs"};function Qe(e){return(0,d.jsx)("div",{role:"presentation",...e,className:(0,i.Z)("navbar-sidebar__backdrop",e.className)})}function Ye(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,k.L)(),r=(0,I.e)(),{navbarRef:s,isNavbarVisible:u}=function(e){const[t,n]=(0,a.useState)(e),i=(0,a.useRef)(!1),o=(0,a.useRef)(0),r=(0,a.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,A.RF)(((t,a)=>{let{scrollY:r}=t;if(!e)return;if(r=s?n(!1):r+l{if(!e)return;const a=t.location.hash;if(a?document.getElementById(a.substring(1)):void 0)return i.current=!0,void n(!1);n(!0)})),{navbarRef:r,isNavbarVisible:t}}(n);return(0,d.jsxs)("nav",{ref:s,"aria-label":(0,c.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,i.Z)("navbar","navbar--fixed-top",n&&[qe.navbarHideable,!u&&qe.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":r.shown}),children:[t,(0,d.jsx)(Qe,{onClick:r.toggle}),(0,d.jsx)(Ge,{})]})}var Xe=n(19441);const Je="right";function et(e){let{width:t=30,height:n=30,className:a,...i}=e;return(0,d.jsx)("svg",{className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...i,children:(0,d.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function tt(){const{toggle:e,shown:t}=(0,I.e)();return(0,d.jsx)("button",{onClick:e,"aria-label":(0,c.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,d.jsx)(et,{})})}const nt={colorModeToggle:"colorModeToggle_Hewu"};function at(e){let{items:t}=e;return(0,d.jsx)(d.Fragment,{children:t.map(((e,t)=>(0,d.jsx)(Xe.QW,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,d.jsx)(Ve,{...e})},t)))})}function it(e){let{left:t,right:n}=e;return(0,d.jsxs)("div",{className:"navbar__inner",children:[(0,d.jsx)("div",{className:"navbar__items",children:t}),(0,d.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function ot(){const e=(0,I.e)(),t=(0,k.L)().navbar.items,[n,a]=function(e){function t(e){return"left"===(e.position??Je)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),i=t.find((e=>"search"===e.type));return(0,d.jsx)(it,{left:(0,d.jsxs)(d.Fragment,{children:[!e.disabled&&(0,d.jsx)(tt,{}),(0,d.jsx)(G,{}),(0,d.jsx)(at,{items:n})]}),right:(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(at,{items:a}),(0,d.jsx)(Z,{className:nt.colorModeToggle}),!i&&(0,d.jsx)(Fe,{children:(0,d.jsx)(De,{})})]})})}function rt(){return(0,d.jsx)(Ye,{children:(0,d.jsx)(ot,{})})}function st(e){let{item:t}=e;const{to:n,href:a,label:i,prependBaseUrlToHref:o,...r}=t,s=(0,X.ZP)(n),c=(0,X.ZP)(a,{forcePrependBaseUrl:!0});return(0,d.jsxs)(Y.Z,{className:"footer__link-item",...a?{href:o?c:a}:{to:s},...r,children:[i,a&&!(0,J.Z)(a)&&(0,d.jsx)(te.Z,{})]})}function ct(e){let{item:t}=e;return t.html?(0,d.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)("li",{className:"footer__item",children:(0,d.jsx)(st,{item:t})},t.href??t.to)}function lt(e){let{column:t}=e;return(0,d.jsxs)("div",{className:"col footer__col",children:[(0,d.jsx)("div",{className:"footer__title",children:t.title}),(0,d.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,d.jsx)(ct,{item:e},t)))})]})}function dt(e){let{columns:t}=e;return(0,d.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,d.jsx)(lt,{column:e},t)))})}function ut(){return(0,d.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function pt(e){let{item:t}=e;return t.html?(0,d.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,d.jsx)(st,{item:t})}function ft(e){let{links:t}=e;return(0,d.jsx)("div",{className:"footer__links text--center",children:(0,d.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,d.jsxs)(a.Fragment,{children:[(0,d.jsx)(pt,{item:e}),t.length!==n+1&&(0,d.jsx)(ut,{})]},n)))})})}function mt(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,d.jsx)(dt,{columns:t}):(0,d.jsx)(ft,{links:t})}var bt=n(66925);const gt={footerLogoLink:"footerLogoLink_tutC"};function ht(e){let{logo:t}=e;const{withBaseUrl:n}=(0,X.Cg)(),a={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,d.jsx)(bt.Z,{className:(0,i.Z)("footer__logo",t.className),alt:t.alt,sources:a,width:t.width,height:t.height,style:t.style})}function yt(e){let{logo:t}=e;return t.href?(0,d.jsx)(Y.Z,{href:t.href,className:gt.footerLogoLink,target:t.target,children:(0,d.jsx)(ht,{logo:t})}):(0,d.jsx)(ht,{logo:t})}function vt(e){let{copyright:t}=e;return(0,d.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function kt(e){let{style:t,links:n,logo:a,copyright:o}=e;return(0,d.jsx)("footer",{className:(0,i.Z)("footer",{"footer--dark":"dark"===t}),children:(0,d.jsxs)("div",{className:"container container-fluid",children:[n,(a||o)&&(0,d.jsxs)("div",{className:"footer__bottom text--center",children:[a&&(0,d.jsx)("div",{className:"margin-bottom--sm",children:a}),o]})]})})}function St(){const{footer:e}=(0,k.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:i}=e;return(0,d.jsx)(kt,{style:i,links:n&&n.length>0&&(0,d.jsx)(mt,{links:n}),logo:a&&(0,d.jsx)(yt,{logo:a}),copyright:t&&(0,d.jsx)(vt,{copyright:t})})}const xt=a.memo(St),wt=(0,R.Qc)([F.S,S.p,A.OC,$e.L5,r.VC,function(e){let{children:t}=e;return(0,d.jsx)(O.n2,{children:(0,d.jsx)(I.M,{children:(0,d.jsx)(N,{children:t})})})}]);function _t(e){let{children:t}=e;return(0,d.jsx)(wt,{children:t})}var Ct=n(1999);function Et(e){let{error:t,tryAgain:n}=e;return(0,d.jsx)("main",{className:"container margin-vert--xl",children:(0,d.jsx)("div",{className:"row",children:(0,d.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,d.jsx)(Ct.Z,{as:"h1",className:"hero__title",children:(0,d.jsx)(c.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,d.jsx)("div",{className:"margin-vert--lg",children:(0,d.jsx)(Xe.Cw,{onClick:n,className:"button button--primary shadow--lw"})}),(0,d.jsx)("hr",{}),(0,d.jsx)("div",{className:"margin-vert--md",children:(0,d.jsx)(Xe.aG,{error:t})})]})})})}const Pt={mainWrapper:"mainWrapper_MB5r"};function Tt(e){const{children:t,noFooter:n,wrapperClassName:a,title:s,description:c}=e;return(0,h.t)(),(0,d.jsxs)(_t,{children:[(0,d.jsx)(r.d,{title:s,description:c}),(0,d.jsx)(v,{}),(0,d.jsx)(T,{}),(0,d.jsx)(rt,{}),(0,d.jsx)("div",{id:u,className:(0,i.Z)(g.k.wrapper.main,Pt.mainWrapper,a),children:(0,d.jsx)(o.Z,{fallback:e=>(0,d.jsx)(Et,{...e}),children:t})}),!n&&(0,d.jsx)(xt,{})]})}},10898:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});n(27378);var a=n(36641),i=n(98948),o=n(50353),r=n(20624),s=n(66925),c=n(24246);function l(e){let{logo:t,alt:n,imageClassName:a}=e;const o={light:(0,i.ZP)(t.src),dark:(0,i.ZP)(t.srcDark||t.src)},r=(0,c.jsx)(s.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return a?(0,c.jsx)("div",{className:a,children:r}):r}function d(e){const{siteConfig:{title:t}}=(0,o.Z)(),{navbar:{title:n,logo:s}}=(0,r.L)(),{imageClassName:d,titleClassName:u,...p}=e,f=(0,i.ZP)(s?.href||"/"),m=n?"":t,b=s?.alt??m;return(0,c.jsxs)(a.Z,{to:f,...p,...s?.target&&{target:s.target},children:[s&&(0,c.jsx)(l,{logo:s,alt:b,imageClassName:d}),null!=n&&(0,c.jsx)("b",{className:u,children:n})]})}},60505:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(27378);var a=n(7092),i=n(24246);function o(e){let{locale:t,version:n,tag:o}=e;const r=t;return(0,i.jsxs)(a.Z,{children:[t&&(0,i.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,i.jsx)("meta",{name:"docusaurus_version",content:n}),o&&(0,i.jsx)("meta",{name:"docusaurus_tag",content:o}),r&&(0,i.jsx)("meta",{name:"docsearch:language",content:r}),n&&(0,i.jsx)("meta",{name:"docsearch:version",content:n}),o&&(0,i.jsx)("meta",{name:"docsearch:docusaurus_tag",content:o})]})}},66925:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var a=n(27378),i=n(40624),o=n(76457),r=n(55421);const s={themedComponent:"themedComponent_siVc","themedComponent--light":"themedComponent--light_hHel","themedComponent--dark":"themedComponent--dark_yETr"};var c=n(24246);function l(e){let{className:t,children:n}=e;const l=(0,o.Z)(),{colorMode:d}=(0,r.I)();return(0,c.jsx)(c.Fragment,{children:(l?"dark"===d?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,i.Z)(t,s.themedComponent,s[`themedComponent--${e}`])});return(0,c.jsx)(a.Fragment,{children:o},e)}))})}function d(e){const{sources:t,className:n,alt:a,...i}=e;return(0,c.jsx)(l,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,c.jsx)("img",{src:t[n],alt:a,className:o,...i})}})}},80376:(e,t,n)=>{"use strict";n.d(t,{u:()=>l,z:()=>h});var a=n(27378),i=n(161),o=n(9834),r=n(56903),s=n(24246);const c="ease-in-out";function l(e){let{initialState:t}=e;const[n,i]=(0,a.useState)(t??!1),o=(0,a.useCallback)((()=>{i((e=>!e))}),[]);return{collapsed:n,setCollapsed:i,toggleCollapsed:o}}const d={display:"none",overflow:"hidden",height:"0px"},u={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?d:u;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:i}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=i?.duration??function(e){if((0,r.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${i?.easing??c}`,height:`${t}px`}}function s(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return p(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=d.height,e.style.overflow=d.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,i])}function m(e){if(!i.Z.canUseDOM)return e?d:u}function b(e){let{as:t="div",collapsed:n,children:i,animation:o,onCollapseTransitionEnd:r,className:c,disableSSRStyle:l}=e;const d=(0,a.useRef)(null);return f({collapsibleRef:d,collapsed:n,animation:o}),(0,s.jsx)(t,{ref:d,style:l?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(d.current,n),r?.(n))},className:c,children:i})}function g(e){let{collapsed:t,...n}=e;const[i,r]=(0,a.useState)(!t),[c,l]=(0,a.useState)(t);return(0,o.Z)((()=>{t||r(!0)}),[t]),(0,o.Z)((()=>{i&&l(t)}),[i,t]),i?(0,s.jsx)(b,{...n,collapsed:c}):null}function h(e){let{lazy:t,...n}=e;const a=t?g:b;return(0,s.jsx)(a,{...n})}},10:(e,t,n)=>{"use strict";n.d(t,{n:()=>b,p:()=>m});var a=n(27378),i=n(76457),o=n(55643),r=n(41763),s=n(20624),c=n(24246);const l=(0,o.WA)("docusaurus.announcement.dismiss"),d=(0,o.WA)("docusaurus.announcement.id"),u=()=>"true"===l.get(),p=e=>l.set(String(e)),f=a.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.L)(),t=(0,i.Z)(),[n,o]=(0,a.useState)((()=>!!t&&u()));(0,a.useEffect)((()=>{o(u())}),[]);const r=(0,a.useCallback)((()=>{p(!0),o(!0)}),[]);return(0,a.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=d.get();"annoucement-bar"===n&&(n="announcement-bar");const a=t!==n;d.set(t),a&&p(!1),!a&&u()||o(!1)}),[e]),(0,a.useMemo)((()=>({isActive:!!e&&!n,close:r})),[e,n,r])}();return(0,c.jsx)(f.Provider,{value:n,children:t})}function b(){const e=(0,a.useContext)(f);if(!e)throw new r.i6("AnnouncementBarProvider");return e}},55421:(e,t,n)=>{"use strict";n.d(t,{I:()=>h,S:()=>g});var a=n(27378),i=n(161),o=n(41763),r=n(55643),s=n(20624),c=n(24246);const l=a.createContext(void 0),d="theme",u=(0,r.WA)(d),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>i.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),b=e=>{u.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.L)(),[i,o]=(0,a.useState)(m(e));(0,a.useEffect)((()=>{t&&u.del()}),[t]);const r=(0,a.useCallback)((function(t,a){void 0===a&&(a={});const{persist:i=!0}=a;t?(o(t),i&&b(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),u.del())}),[n,e]);(0,a.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(i))}),[i]),(0,a.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==d)return;const t=u.get();null!==t&&r(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,r]);const c=(0,a.useRef)(!1);return(0,a.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),a=()=>{window.matchMedia("print").matches||c.current?c.current=window.matchMedia("print").matches:r(null)};return e.addListener(a),()=>e.removeListener(a)}),[r,t,n]),(0,a.useMemo)((()=>({colorMode:i,setColorMode:r,get isDarkTheme(){return i===p.dark},setLightTheme(){r(p.light)},setDarkTheme(){r(p.dark)}})),[i,r])}();return(0,c.jsx)(l.Provider,{value:n,children:t})}function h(){const e=(0,a.useContext)(l);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},24453:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>h,Oh:()=>k});var a=n(27378),i=n(62935),o=n(45688),r=n(20624),s=n(45161),c=n(41763),l=n(55643),d=n(24246);const u=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,l.WA)(u(e),{persistence:t}).set(n)},read:(e,t)=>(0,l.WA)(u(e),{persistence:t}).get(),clear:(e,t)=>{(0,l.WA)(u(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const m=a.createContext(null);function b(){const e=(0,i._r)(),t=(0,r.L)().docs.versionPersistence,n=(0,a.useMemo)((()=>Object.keys(e)),[e]),[o,s]=(0,a.useState)((()=>f(n)));(0,a.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:a}=e;function i(e){const t=p.read(e,n);return a[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,i(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,a.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=b();return(0,d.jsx)(m.Provider,{value:n,children:t})}function h(e){let{children:t}=e;return s.cE?(0,d.jsx)(g,{children:t}):(0,d.jsx)(d.Fragment,{children:t})}function y(){const e=(0,a.useContext)(m);if(!e)throw new c.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,i.zh)(e),[n,r]=y(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,a.useCallback)((t=>{r.savePreferredVersion(e,t)}),[r,e])}}function k(){const e=(0,i._r)(),[t]=y();function n(n){const a=e[n],{preferredVersionName:i}=t[n];return a.versions.find((e=>e.name===i))??null}const a=Object.keys(e);return Object.fromEntries(a.map((e=>[e,n(e)])))}},52095:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,b:()=>c});var a=n(27378),i=n(41763),o=n(24246);const r=Symbol("EmptyContext"),s=a.createContext(r);function c(e){let{children:t,name:n,items:i}=e;const r=(0,a.useMemo)((()=>n&&i?{name:n,items:i}:null),[n,i]);return(0,o.jsx)(s.Provider,{value:r,children:t})}function l(){const e=(0,a.useContext)(s);if(e===r)throw new i.i6("DocsSidebarProvider");return e}},25611:(e,t,n)=>{"use strict";n.d(t,{E:()=>c,q:()=>s});var a=n(27378),i=n(41763),o=n(24246);const r=a.createContext(null);function s(e){let{children:t,version:n}=e;return(0,o.jsx)(r.Provider,{value:n,children:t})}function c(){const e=(0,a.useContext)(r);if(null===e)throw new i.i6("DocsVersionProvider");return e}},85536:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var a=n(27378),i=n(63471),o=n(58357),r=n(30654),s=n(20624),c=n(41763),l=n(24246);const d=a.createContext(void 0);function u(){const e=function(){const e=(0,i.HY)(),{items:t}=(0,s.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[c,l]=(0,a.useState)(!1);(0,r.Rb)((()=>{if(c)return l(!1),!1}));const d=(0,a.useCallback)((()=>{l((e=>!e))}),[]);return(0,a.useEffect)((()=>{"desktop"===t&&l(!1)}),[t]),(0,a.useMemo)((()=>({disabled:e,shouldRender:n,toggle:d,shown:c})),[e,n,d,c])}function p(e){let{children:t}=e;const n=u();return(0,l.jsx)(d.Provider,{value:n,children:t})}function f(){const e=a.useContext(d);if(void 0===e)throw new c.i6("NavbarMobileSidebarProvider");return e}},63471:(e,t,n)=>{"use strict";n.d(t,{HY:()=>c,Zo:()=>l,n2:()=>s});var a=n(27378),i=n(41763),o=n(24246);const r=a.createContext(null);function s(e){let{children:t}=e;const n=(0,a.useState)({component:null,props:null});return(0,o.jsx)(r.Provider,{value:n,children:t})}function c(){const e=(0,a.useContext)(r);if(!e)throw new i.i6("NavbarSecondaryMenuContentProvider");return e[0]}function l(e){let{component:t,props:n}=e;const o=(0,a.useContext)(r);if(!o)throw new i.i6("NavbarSecondaryMenuContentProvider");const[,s]=o,c=(0,i.Ql)(n);return(0,a.useEffect)((()=>{s({component:t,props:c})}),[s,t,c]),(0,a.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},70174:(e,t,n)=>{"use strict";n.d(t,{h:()=>i,t:()=>o});var a=n(27378);const i="navigation-with-keyboard";function o(){(0,a.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(i),"mousedown"===e.type&&document.body.classList.remove(i)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(i),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},53584:(e,t,n)=>{"use strict";n.d(t,{K:()=>s,M:()=>c});var a=n(27378),i=n(50353),o=n(30654);const r="q";function s(){return(0,o.Nc)(r)}function c(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,i.Z)(),{algolia:{searchPagePath:n}}=t;return(0,a.useCallback)((t=>`${e}${n}?${r}=${encodeURIComponent(t)}`),[e,n])}},58357:(e,t,n)=>{"use strict";n.d(t,{i:()=>s});var a=n(27378),i=n(161);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},r=996;function s(e){let{desktopBreakpoint:t=r}=void 0===e?{}:e;const[n,s]=(0,a.useState)((()=>"ssr"));return(0,a.useEffect)((()=>{function e(){s(function(e){if(!i.Z.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?o.desktop:o.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},75484:(e,t,n)=>{"use strict";n.d(t,{k:()=>a});const a={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},56903:(e,t,n)=>{"use strict";function a(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>a})},45161:(e,t,n)=>{"use strict";n.d(t,{LM:()=>f,SN:()=>_,_F:()=>g,cE:()=>p,f:()=>y,lO:()=>S,oz:()=>x,s1:()=>k,vY:()=>w});var a=n(27378),i=n(48165),o=n(95473),r=n(62935),s=n(24453),c=n(25611),l=n(52095),d=n(70784),u=n(8862);const p=!!r._r;function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}const m=(e,t)=>void 0!==e&&(0,u.Mg)(e,t),b=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?m(e.href,t):"category"===e.type&&(m(e.href,t)||b(e.items,t))}function h(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>h(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function y(e,t){return(0,a.useMemo)((()=>e.filter((e=>h(e,t)))),[e,t])}function v(e){let{sidebarItems:t,pathname:n,onlyCategories:a=!1}=e;const i=[];return function e(t){for(const o of t)if("category"===o.type&&((0,u.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,u.Mg)(o.href,n)){return a&&"category"!==o.type||i.unshift(o),!0}return!1}(t),i}function k(){const e=(0,l.V)(),{pathname:t}=(0,i.TH)(),n=(0,r.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?v({sidebarItems:e.items,pathname:t}):null}function S(e){const{activeVersion:t}=(0,r.Iw)(e),{preferredVersion:n}=(0,s.J)(e),i=(0,r.yW)(e);return(0,a.useMemo)((()=>(0,d.j)([t,n,i].filter(Boolean))),[t,n,i])}function x(e,t){const n=S(t);return(0,a.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),a=t.find((t=>t[0]===e));if(!a)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return a[1]}),[e,n])}function w(e,t){const n=S(t);return(0,a.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),a=t.find((t=>t.id===e));if(!a){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,d.j)(t.map((e=>e.id))).join("\n- ")}`)}return a}),[e,n])}function _(e){let{route:t}=e;const n=(0,i.TH)(),a=(0,c.E)(),r=t.routes,s=r.find((e=>(0,i.LX)(n.pathname,e)));if(!s)return null;const l=s.sidebar,d=l?a.docsSidebars[l]:void 0;return{docElement:(0,o.H)(r),sidebarName:l,sidebarItems:d}}},19441:(e,t,n)=>{"use strict";n.d(t,{aG:()=>d,Ac:()=>l,Cw:()=>c,QW:()=>u});var a=n(27378),i=n(99213),o=n(51721);const r={errorBoundaryError:"errorBoundaryError_WE6Q",errorBoundaryFallback:"errorBoundaryFallback_bdJX"};var s=n(24246);function c(e){return(0,s.jsx)("button",{type:"button",...e,children:(0,s.jsx)(i.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function l(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)("div",{className:r.errorBoundaryFallback,children:[(0,s.jsx)("p",{children:t.message}),(0,s.jsx)(c,{onClick:n})]})}function d(e){let{error:t}=e;const n=(0,o.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{className:r.errorBoundaryError,children:n})}class u extends a.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}},99162:(e,t,n)=>{"use strict";n.d(t,{p:()=>i});var a=n(50353);function i(e){const{siteConfig:t}=(0,a.Z)(),{title:n,titleDelimiter:i}=t;return e?.trim().length?`${e.trim()} ${i} ${n}`:n}},30654:(e,t,n)=>{"use strict";n.d(t,{Nc:()=>l,Rb:()=>r,_X:()=>c});var a=n(27378),i=n(48165),o=n(41763);function r(e){!function(e){const t=(0,i.k6)(),n=(0,o.zX)(e);(0,a.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function s(e){const t=(0,i.k6)();return(0,a.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function c(e){return s((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function l(e){const t=c(e)??"",n=function(e){const t=(0,i.k6)();return(0,a.useCallback)(((n,a)=>{const i=new URLSearchParams(t.location.search);n?i.set(e,n):i.delete(e),(a?.push?t.push:t.replace)({search:i.toString()})}),[e,t])}(e);return[t,n]}},70784:(e,t,n)=>{"use strict";function a(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,a)=>e.findIndex((e=>t(e,n)))!==a))}function i(e){return Array.from(new Set(e))}n.d(t,{j:()=>i,l:()=>a})},88676:(e,t,n)=>{"use strict";n.d(t,{FG:()=>p,VC:()=>f,d:()=>d});var a=n(27378),i=n(40624),o=n(7092),r=n(74909),s=n(98948),c=n(99162),l=n(24246);function d(e){let{title:t,description:n,keywords:a,image:i,children:r}=e;const d=(0,c.p)(t),{withBaseUrl:u}=(0,s.Cg)(),p=i?u(i,{absolute:!0}):void 0;return(0,l.jsxs)(o.Z,{children:[t&&(0,l.jsx)("title",{children:d}),t&&(0,l.jsx)("meta",{property:"og:title",content:d}),n&&(0,l.jsx)("meta",{name:"description",content:n}),n&&(0,l.jsx)("meta",{property:"og:description",content:n}),a&&(0,l.jsx)("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),p&&(0,l.jsx)("meta",{property:"og:image",content:p}),p&&(0,l.jsx)("meta",{name:"twitter:image",content:p}),r]})}const u=a.createContext(void 0);function p(e){let{className:t,children:n}=e;const r=a.useContext(u),s=(0,i.Z)(r,t);return(0,l.jsxs)(u.Provider,{value:s,children:[(0,l.jsx)(o.Z,{children:(0,l.jsx)("html",{className:s})}),n]})}function f(e){let{children:t}=e;const n=(0,r.Z)(),a=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${n.plugin.id}`;return(0,l.jsx)(p,{className:(0,i.Z)(a,o),children:t})}},41763:(e,t,n)=>{"use strict";n.d(t,{D9:()=>s,Qc:()=>d,Ql:()=>l,i6:()=>c,zX:()=>r});var a=n(27378),i=n(9834),o=n(24246);function r(e){const t=(0,a.useRef)(e);return(0,i.Z)((()=>{t.current=e}),[e]),(0,a.useCallback)((function(){return t.current(...arguments)}),[])}function s(e){const t=(0,a.useRef)();return(0,i.Z)((()=>{t.current=e})),t.current}class c extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function l(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,a.useMemo)((()=>e),t.flat())}function d(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},61503:(e,t,n)=>{"use strict";function a(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{F:()=>a})},8862:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>r,Ns:()=>s});var a=n(27378),i=n(76623),o=n(50353);function r(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,a.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function a(e){return e.path===t&&!0===e.exact}function i(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(a)||e(t.filter(i).flatMap((e=>e.routes??[])))}(n)}({routes:i.Z,baseUrl:e})),[e])}},83457:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>b,OC:()=>d,RF:()=>f,o5:()=>m});var a=n(27378),i=n(161),o=n(76457),r=n(9834),s=n(41763),c=n(24246);const l=a.createContext(void 0);function d(e){let{children:t}=e;const n=function(){const e=(0,a.useRef)(!0);return(0,a.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,c.jsx)(l.Provider,{value:n,children:t})}function u(){const e=(0,a.useContext)(l);if(null==e)throw new s.i6("ScrollControllerProvider");return e}const p=()=>i.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=u(),i=(0,a.useRef)(p()),o=(0,s.zX)(e);(0,a.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();o(e,i.current),i.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function m(){const e=u(),t=function(){const e=(0,a.useRef)({elem:null,top:0}),t=(0,a.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,a.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const a=t.getBoundingClientRect().top-n;return a&&window.scrollBy({left:0,top:a}),e.current={elem:null,top:0},{restored:0!==a}}),[]);return(0,a.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,a.useRef)(void 0),i=(0,a.useCallback)((a=>{t.save(a),e.disableScrollEvents(),n.current=()=>{const{restored:a}=t.restore();if(n.current=void 0,a){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,r.Z)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:i}}function b(){const e=(0,a.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function a(){const i=document.documentElement.scrollTop;(n&&i>e||!n&&it&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},13149:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,_q:()=>c,os:()=>s});var a=n(62935),i=n(50353),o=n(24453);const r="default";function s(e,t){return`docs-${e}-${t}`}function c(){const{i18n:e}=(0,i.Z)(),t=(0,a._r)(),n=(0,a.WS)(),c=(0,o.Oh)();const l=[r,...Object.keys(t).map((function(e){const a=n?.activePlugin.pluginId===e?n.activeVersion:void 0,i=c[e],o=t[e].versions.find((e=>e.isLast));return s(e,(a??i??o).name)}))];return{locale:e.currentLocale,tags:l}}},55643:(e,t,n)=>{"use strict";n.d(t,{WA:()=>d,Nk:()=>u});var a=n(27378);const i=JSON.parse('{"d":"localStorage","u":""}'),o=i.d;function r(e){let{key:t,oldValue:n,newValue:a,storage:i}=e;if(n===a)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,a,window.location.href,i),window.dispatchEvent(o)}function s(e){if(void 0===e&&(e=o),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,c||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),c=!0),null}var t}let c=!1;const l={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function d(e,t){const n=`${e}${i.u}`;if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(n);const a=s(t?.persistence);return null===a?l:{get:()=>{try{return a.getItem(n)}catch(e){return console.error(`Docusaurus storage error, can't get key=${n}`,e),null}},set:e=>{try{const t=a.getItem(n);a.setItem(n,e),r({key:n,oldValue:t,newValue:e,storage:a})}catch(t){console.error(`Docusaurus storage error, can't set ${n}=${e}`,t)}},del:()=>{try{const e=a.getItem(n);a.removeItem(n),r({key:n,oldValue:e,newValue:null,storage:a})}catch(e){console.error(`Docusaurus storage error, can't delete key=${n}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===a&&t.key===n&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${n}`,t),()=>{}}}}}function u(e,t){const n=(0,a.useRef)((()=>null===e?l:d(e,t))).current(),i=(0,a.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,a.useSyncExternalStore)(i,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},43714:(e,t,n)=>{"use strict";n.d(t,{l:()=>r});var a=n(50353),i=n(48165),o=n(51721);function r(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:r,currentLocale:s}}=(0,a.Z)(),{pathname:c}=(0,i.TH)(),l=(0,o.applyTrailingSlash)(c,{trailingSlash:n,baseUrl:e}),d=s===r?e:e.replace(`/${s}/`,"/"),u=l.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:a}=e;return`${a?t:""}${function(e){return e===r?`${d}`:`${d}${e}/`}(n)}${u}`}}}},24993:(e,t,n)=>{"use strict";n.d(t,{S:()=>r});var a=n(27378),i=n(48165),o=n(41763);function r(e){const t=(0,i.TH)(),n=(0,o.D9)(t),r=(0,o.zX)(e);(0,a.useEffect)((()=>{n&&t!==n&&r({location:t,previousLocation:n})}),[r,t,n])}},20624:(e,t,n)=>{"use strict";n.d(t,{L:()=>i});var a=n(50353);function i(){return(0,a.Z)().siteConfig.themeConfig}},80632:(e,t,n)=>{"use strict";n.d(t,{L:()=>i});var a=n(50353);function i(){const{siteConfig:{themeConfig:e}}=(0,a.Z)();return e}},42473:(e,t,n)=>{"use strict";n.d(t,{l:()=>s});var a=n(27378),i=n(61503),o=n(98948),r=n(80632);function s(){const{withBaseUrl:e}=(0,o.Cg)(),{algolia:{externalUrlRegex:t,replaceSearchResultPathname:n}}=(0,r.L)();return(0,a.useCallback)((a=>{const o=new URL(a);if((0,i.F)(t,o.href))return a;const r=`${o.pathname+o.hash}`;return e(function(e,t){return t?e.replaceAll(new RegExp(t.from,"g"),t.to):e}(r,n))}),[e,t,n])}},42520:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=void 0;const a=n(45313);function i(e){return e.endsWith("/")?e:`${e}/`}function o(e){return(0,a.removeSuffix)(e,"/")}t.addTrailingSlash=i,t.default=function(e,t){const{trailingSlash:n,baseUrl:a}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[r]=e.split(/[#?]/),s="/"===r||r===a?r:(c=r,n?i(c):o(c));var c;return e.replace(r,s)},t.addLeadingSlash=function(e){return(0,a.addPrefix)(e,"/")},t.removeTrailingSlash=o},86102:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},51721:function(e,t,n){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var i=n(42520);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return a(i).default}}),Object.defineProperty(t,"addTrailingSlash",{enumerable:!0,get:function(){return i.addTrailingSlash}}),Object.defineProperty(t,"addLeadingSlash",{enumerable:!0,get:function(){return i.addLeadingSlash}}),Object.defineProperty(t,"removeTrailingSlash",{enumerable:!0,get:function(){return i.removeTrailingSlash}});var o=n(45313);Object.defineProperty(t,"addPrefix",{enumerable:!0,get:function(){return o.addPrefix}}),Object.defineProperty(t,"removeSuffix",{enumerable:!0,get:function(){return o.removeSuffix}}),Object.defineProperty(t,"addSuffix",{enumerable:!0,get:function(){return o.addSuffix}}),Object.defineProperty(t,"removePrefix",{enumerable:!0,get:function(){return o.removePrefix}});var r=n(86102);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return r.getErrorCausalChain}})},45313:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=void 0,t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){return""===t?e:e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},76623:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(27378);var a=n(51237),i=n.n(a),o=n(16887);const r={"0029a336":[()=>n.e(19093).then(n.bind(n,14583)),"@site/api/namespaces/window/functions/withProgress.md",14583],"0058b4c6":[()=>n.e(64088).then(n.t.bind(n,66462,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-175.json",66462],"006e489c":[()=>Promise.all([n.e(95628),n.e(28145)]).then(n.bind(n,11956)),"@site/blog/2023-03-29-release-0.13.md",11956],"00e9d6a1":[()=>n.e(23493).then(n.t.bind(n,25648,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-podman-desktop-b93.json",25648],"0102eb3e":[()=>n.e(75542).then(n.bind(n,66777)),"@site/api/interfaces/WebviewInfo.md",66777],"014457dd":[()=>n.e(66521).then(n.bind(n,57258)),"@site/docs/containers/images/building-an-image.md",57258],"016e89ec":[()=>n.e(43582).then(n.t.bind(n,33369,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-mac-os-0f5.json",33369],"01821883":[()=>n.e(77683).then(n.bind(n,95061)),"@site/api/interfaces/DeviceRequest.md",95061],"01a1d0f4":[()=>n.e(13826).then(n.bind(n,96261)),"@site/api/namespaces/provider/functions/onDidUnregisterContainerConnection.md",96261],"01a85c17":[()=>Promise.all([n.e(40532),n.e(64013)]).then(n.bind(n,79898)),"@theme/BlogTagsListPage",79898],"021eaa84":[()=>Promise.all([n.e(95628),n.e(47875)]).then(n.bind(n,61708)),"@site/blog/2023-11-03-release-1.5.md?truncated=true",61708],"030ccfd9":[()=>n.e(67690).then(n.bind(n,38650)),"@site/api/namespaces/kubernetes/functions/getKubeconfig.md",38650],"0341d436":[()=>n.e(31402).then(n.t.bind(n,27033,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-settings-192.json",27033],"0433ef30":[()=>n.e(19282).then(n.t.bind(n,17979,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-migrating-from-docker-612.json",17979],"04a546a4":[()=>n.e(17329).then(n.bind(n,44419)),"@site/api/interfaces/Clipboard.md",44419],"0547cb65":[()=>n.e(30060).then(n.bind(n,6204)),"@site/api/enumerations/QuickPickItemKind.md",6204],"059d1c6a":[()=>Promise.all([n.e(18565),n.e(9928),n.e(58262)]).then(n.bind(n,96187)),"@site/src/pages/downloads/index.tsx",96187],"065365b3":[()=>n.e(43871).then(n.bind(n,90952)),"@site/api/interfaces/ImageChecks.md",90952],"06a27da2":[()=>n.e(14824).then(n.bind(n,1590)),"@site/api/interfaces/PodInfo.md",1590],"07305c4a":[()=>n.e(7809).then(n.bind(n,53277)),"@site/api/index.md",53277],"07f59c2a":[()=>n.e(89372).then(n.bind(n,80272)),"@site/blog/2022-12-01-release-0.10-blog.md",80272],"0877aebd":[()=>n.e(87213).then(n.bind(n,27062)),"@site/api/interfaces/AuthenticationProviderOptions.md",27062],"09788c0c":[()=>n.e(82144).then(n.bind(n,59828)),"@site/api/namespaces/context/index.md",59828],"09b168a7":[()=>n.e(29579).then(n.bind(n,95071)),"@site/docs/minikube/index.md",95071],"0c14b239":[()=>n.e(34479).then(n.bind(n,55264)),"@site/api/namespaces/configuration/functions/onDidChangeConfiguration.md",55264],"0c4fad6b":[()=>n.e(41976).then(n.bind(n,5862)),"@site/api/namespaces/navigation/functions/navigateToAuthentication.md",5862],"0cab2b3a":[()=>n.e(85714).then(n.bind(n,25710)),"@site/api/namespaces/commands/functions/executeCommand.md",25710],"0dd9aaeb":[()=>n.e(67966).then(n.bind(n,67945)),"@site/docs/ai-lab/download-model.md",67945],"0e384e19":[()=>n.e(59671).then(n.bind(n,87979)),"@site/docs/intro.md",87979],"0e3a398f":[()=>n.e(30466).then(n.bind(n,80171)),"@site/api/interfaces/KubernetesProviderConnectionEndpoint.md",80171],"0e72c11a":[()=>n.e(19536).then(n.bind(n,85226)),"@site/api/namespaces/navigation/functions/navigateToResources.md",85226],"0f54081d":[()=>n.e(37073).then(n.bind(n,81497)),"@site/api/namespaces/provider/functions/getProviderLifecycleContext.md",81497],"0fa6e9bf":[()=>n.e(54063).then(n.bind(n,71683)),"@site/api/namespaces/env/functions/openExternal.md",71683],10091836:[()=>n.e(77673).then(n.t.bind(n,80816,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-kubernetes-cf0.json",80816],10210328:[()=>n.e(38943).then(n.bind(n,97958)),"@site/api/namespaces/extensions/functions/getExtension.md",97958],"107d77e6":[()=>n.e(51051).then(n.bind(n,14914)),"@site/api/interfaces/ListInfosOptions.md",14914],"10ce918d":[()=>n.e(37918).then(n.bind(n,17265)),"@site/docs/lima/creating-a-lima-instance.md",17265],"123a454a":[()=>n.e(29693).then(n.bind(n,55600)),"@site/api/interfaces/RunResult.md",55600],"125d93c1":[()=>n.e(22228).then(n.bind(n,14566)),"@site/api/namespaces/navigation/functions/navigateToPods.md",14566],"12eb386e":[()=>n.e(89950).then(n.bind(n,71960)),"@site/api/interfaces/CliToolOptions.md",71960],"12f1535e":[()=>n.e(44781).then(n.bind(n,61645)),"@site/blog/2023-02-15-release-0.12.md?truncated=true",61645],"1369aff7":[()=>n.e(61866).then(n.bind(n,49783)),"@site/docs/kubernetes/lima/pushing-an-image-to-lima.md",49783],"148448cb":[()=>n.e(72092).then(n.bind(n,66137)),"@site/api/interfaces/ContainerCreateOptions.md",66137],"14ae68e7":[()=>n.e(60574).then(n.bind(n,42761)),"@site/api/interfaces/EndpointIPAMConfig.md",42761],"1515c895":[()=>n.e(38134).then(n.bind(n,86522)),"@site/api/namespaces/navigation/functions/navigateToImage.md",86522],"160cb329":[()=>n.e(3984).then(n.bind(n,2227)),"@site/api/interfaces/ProviderDetectionCheck.md",2227],"164937d2":[()=>n.e(5477).then(n.bind(n,64010)),"@site/api/interfaces/SecretStorage.md",64010],"16914cba":[()=>n.e(64315).then(n.bind(n,57276)),"@site/api/namespaces/containerEngine/functions/deleteContainer.md",57276],"16ce7fd2":[()=>n.e(54184).then(n.t.bind(n,37663,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-wasm-78c.json",37663],"17612ae7":[()=>n.e(97767).then(n.bind(n,72267)),"@site/api/namespaces/containerEngine/functions/deleteImage.md",72267],17896441:[()=>Promise.all([n.e(40532),n.e(18565),n.e(9928),n.e(10787),n.e(27918)]).then(n.bind(n,78516)),"@theme/DocItem",78516],"17d2ebc8":[()=>n.e(14142).then(n.bind(n,89533)),"@site/api/interfaces/ContainerJSONEvent.md",89533],"180d0c5f":[()=>n.e(51499).then(n.bind(n,21101)),"@site/api/interfaces/AuthenticationSessionsChangeEvent.md",21101],"185c52e7":[()=>n.e(90051).then(n.bind(n,36918)),"@site/api/interfaces/VolumeCreateResponseInfo.md",36918],"1949cc8d":[()=>n.e(85210).then(n.bind(n,72997)),"@site/blog/2023-12-06-sharing-podman-images-with-kubernetes-cluster.md?truncated=true",72997],"19e69ccd":[()=>n.e(76091).then(n.bind(n,56826)),"@site/api/interfaces/CPUStats.md",56826],"19eded63":[()=>n.e(4459).then(n.bind(n,67376)),"@site/docs/lima/installing.md",67376],"1a16e8bf":[()=>Promise.all([n.e(95628),n.e(72079)]).then(n.bind(n,7792)),"@site/blog/2023-06-08-release-1.1.md",7792],"1a4e3797":[()=>Promise.all([n.e(40532),n.e(97920)]).then(n.bind(n,36351)),"@theme/SearchPage",36351],"1a906644":[()=>n.e(52525).then(n.bind(n,67681)),"@site/api/namespaces/containerEngine/functions/createManifest.md",67681],"1cfced13":[()=>Promise.all([n.e(95628),n.e(48215)]).then(n.bind(n,36277)),"@site/blog/2023-07-12-release-1.2.md",36277],"1d31e443":[()=>n.e(54194).then(n.bind(n,20822)),"@site/api/namespaces/authentication/index.md",20822],"1df93b7f":[()=>Promise.all([n.e(18565),n.e(9928),n.e(53237)]).then(n.bind(n,168)),"@site/src/pages/index.tsx",168],"1dfee34e":[()=>n.e(15554).then(n.bind(n,93686)),"@site/api/classes/CancellationTokenSource.md",93686],"1e582a71":[()=>n.e(45603).then(n.t.bind(n,99423,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-kind-fe9.json",99423],"1ee92283":[()=>n.e(65144).then(n.bind(n,4226)),"@site/api/interfaces/Provider.md",4226],"1fbe0675":[()=>n.e(39613).then(n.bind(n,68579)),"@site/api/namespaces/fs/functions/createFileSystemWatcher.md",68579],"1fc83a28":[()=>n.e(70633).then(n.bind(n,9146)),"@site/api/interfaces/AuthenticationSession.md",9146],"22de4147":[()=>n.e(5240).then(n.bind(n,85579)),"@site/blog/2023-04-19-running-a-local-kubernetes-cluster-with-podman-desktop.md?truncated=true",85579],"22e2140b":[()=>n.e(24260).then(n.bind(n,47227)),"@site/api/type-aliases/ProviderResult.md",47227],"232c546d":[()=>Promise.all([n.e(18565),n.e(9928),n.e(43163)]).then(n.bind(n,53330)),"@site/src/pages/downloads/macos.tsx",53330],"2340b3ee":[()=>n.e(20205).then(n.bind(n,37099)),"@site/api/namespaces/process/functions/exec.md",37099],"23a8e291":[()=>n.e(43274).then(n.bind(n,87634)),"@site/api/interfaces/ConfigurationChangeEvent.md",87634],"23b35f70":[()=>n.e(82323).then(n.t.bind(n,14102,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-containers-5fb.json",14102],"24bda87b":[()=>n.e(4918).then(n.bind(n,35634)),"@site/docs/podman/creating-a-podman-machine.md",35634],"24dadce3":[()=>n.e(70595).then(n.bind(n,30172)),"@site/api/interfaces/LifecycleContext.md",30172],"254d0ff5":[()=>n.e(60810).then(n.bind(n,37340)),"@site/api/interfaces/ProviderImages.md",37340],25622900:[()=>n.e(61896).then(n.bind(n,26757)),"@site/docs/minikube/creating-a-minikube-cluster.md",26757],"25d1f3de":[()=>n.e(39684).then(n.t.bind(n,29638,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-kubernetes-bf9.json",29638],"2658ced2":[()=>n.e(57881).then(n.bind(n,34481)),"@site/docs/compose/index.md",34481],"271ff0d1":[()=>n.e(86335).then(n.bind(n,89714)),"@site/api/namespaces/window/functions/showOpenDialog.md",89714],"280646e4":[()=>n.e(24726).then(n.bind(n,11024)),"@site/api/interfaces/HealthCheckResults.md",11024],"28d80fa9":[()=>n.e(66362).then(n.t.bind(n,57893,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-pods-653.json",57893],"2ab17a83":[()=>n.e(65431).then(n.t.bind(n,70972,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-minikube-8f0.json",70972],"2bb2c1cd":[()=>n.e(74340).then(n.bind(n,8108)),"@site/api/interfaces/NetworkingConfig.md",8108],"2bbe04e6":[()=>n.e(4220).then(n.bind(n,69515)),"@site/docs/containers/images/index.md",69515],"2cb13d6d":[()=>n.e(86528).then(n.bind(n,69729)),"@site/api/interfaces/BlkioStatEntry.md",69729],"2d629ea6":[()=>n.e(3879).then(n.bind(n,73018)),"@site/docs/kubernetes/deploying-a-container-to-kubernetes.md",73018],"2f7d01f7":[()=>n.e(86535).then(n.t.bind(n,36274,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-web-assembly-d12.json",36274],"2f8f53cb":[()=>n.e(66112).then(n.t.bind(n,71904,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-extension-040.json",71904],"308aae28":[()=>n.e(90522).then(n.bind(n,81897)),"@site/docs/troubleshooting/troubleshooting-podman-on-windows.md",81897],30997935:[()=>n.e(36955).then(n.t.bind(n,2349,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-podman-desktop-529.json",2349],"3109d9d2":[()=>n.e(3745).then(n.bind(n,61123)),"@site/api/namespaces/window/functions/showQuickPick.md",61123],"3132913e":[()=>n.e(68732).then(n.bind(n,83659)),"@site/api/interfaces/SaveDialogOptions.md",83659],"3289a752":[()=>Promise.all([n.e(40532),n.e(68811)]).then(n.bind(n,61636)),"@site/docs/migrating-from-docker/verifying-your-tools-are-using-podman.md",61636],"330b5684":[()=>n.e(33124).then(n.t.bind(n,32746,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-when-clause-f45.json",32746],"330dfcdb":[()=>n.e(4929).then(n.bind(n,61228)),"@site/blog/2023-04-14-release-0.14.md?truncated=true",61228],"33a21d7d":[()=>n.e(83152).then(n.bind(n,98432)),"@site/docs/minikube/installing.md",98432],"33f367df":[()=>n.e(25204).then(n.bind(n,47410)),"@site/api/interfaces/RegistryConfig.md",47410],"3462068c":[()=>n.e(3102).then(n.bind(n,15836)),"@site/api/namespaces/window/index.md",15836],34767260:[()=>Promise.all([n.e(40532),n.e(72179)]).then(n.bind(n,14523)),"@site/blog/2024-01-29-run-webassembly-wasm-workloads-windows-and-macos.md?truncated=true",14523],35300761:[()=>n.e(96120).then(n.bind(n,5052)),"@site/api/interfaces/MenuItem.md",5052],"35dda5a2":[()=>n.e(27104).then(n.bind(n,82348)),"@site/docs/ai-lab/start-inference-server.md",82348],"360dc931":[()=>n.e(78327).then(n.t.bind(n,81403,19)),"@generated/docusaurus-plugin-content-docs/api/__plugin.json",81403],"368cce37":[()=>n.e(82667).then(n.bind(n,63616)),"@site/blog/2023-05-17-release-1.0.md",63616],"36994c47":[()=>n.e(59208).then(n.t.bind(n,94468,19)),"@generated/docusaurus-plugin-content-blog/default/__plugin.json",94468],"3720c009":[()=>Promise.all([n.e(40532),n.e(13751)]).then(n.bind(n,84889)),"@theme/DocTagsListPage",84889],"3819c331":[()=>n.e(3537).then(n.bind(n,78779)),"@site/blog/2024-04-05-release-1.9.md",78779],"3866940b":[()=>n.e(6082).then(n.bind(n,9215)),"@site/api/interfaces/ProviderInformation.md",9215],"38a042e4":[()=>n.e(57138).then(n.bind(n,95583)),"@site/blog/2022-11-17-develop-podman-using-codespaces.md",95583],"38f19abb":[()=>n.e(27222).then(n.t.bind(n,44936,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-kind-a3e.json",44936],"39ae3791":[()=>n.e(955).then(n.bind(n,82687)),"@site/api/interfaces/ProviderLifecycle.md",82687],"3a2db09e":[()=>n.e(99361).then(n.t.bind(n,57588,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-df9.json",57588],"3a38a610":[()=>n.e(91721).then(n.bind(n,12426)),"@site/api/interfaces/ImageInfo.md",12426],"3a4a1d3a":[()=>n.e(10239).then(n.t.bind(n,46696,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-icons-54d.json",46696],"3b68f98c":[()=>n.e(3614).then(n.t.bind(n,3729,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-codespaces-646.json",3729],"3ba80b69":[()=>n.e(3408).then(n.bind(n,60205)),"@site/api/interfaces/HealthCheckLog.md",60205],"3c39daba":[()=>Promise.all([n.e(40532),n.e(75247)]).then(n.bind(n,24574)),"@site/blog/2024-01-29-run-webassembly-wasm-workloads-windows-and-macos.md",24574],"3d8d8999":[()=>n.e(37437).then(n.bind(n,48869)),"@site/api/namespaces/fs/index.md",48869],"3e2b82eb":[()=>n.e(40683).then(n.bind(n,64994)),"@site/api/namespaces/navigation/functions/navigateToVolume.md",64994],"3f29ba7c":[()=>n.e(65181).then(n.t.bind(n,91536,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-generative-ai-666.json",91536],"3f66023b":[()=>n.e(80161).then(n.bind(n,91328)),"@site/api/interfaces/ContainerInfo.md",91328],"3f797343":[()=>n.e(85632).then(n.bind(n,2310)),"@site/api/interfaces/ProviderCleanupExecuteOptions.md",2310],"40d377be":[()=>n.e(14077).then(n.bind(n,53910)),"@site/api/interfaces/ManifestCreateOptions.md",53910],"416d4fcf":[()=>n.e(44422).then(n.bind(n,60855)),"@site/api/interfaces/ContainerCreateResult.md",60855],"41b2e801":[()=>n.e(35137).then(n.bind(n,80995)),"@site/api/namespaces/imageChecker/functions/registerImageCheckerProvider.md",80995],"4213e5b1":[()=>n.e(9973).then(n.bind(n,50930)),"@site/docs/containers/starting-a-container.md",50930],"423842d7":[()=>n.e(27328).then(n.bind(n,88952)),"@site/api/type-aliases/KubernetesGeneratorArgument.md",88952],"42b67a8e":[()=>n.e(54774).then(n.bind(n,38472)),"@site/api/interfaces/HostRestartPolicy.md",38472],"43be69c9":[()=>n.e(86661).then(n.bind(n,48168)),"@site/api/interfaces/QuickPickItem.md",48168],44287967:[()=>n.e(49867).then(n.bind(n,19142)),"@site/api/namespaces/containerEngine/functions/statsContainer.md",19142],"450c2e30":[()=>n.e(34770).then(n.bind(n,78096)),"@site/blog/2023-12-18-release-1.6.md?truncated=true",78096],"456c0e28":[()=>n.e(33279).then(n.bind(n,3494)),"@site/api/interfaces/PodContainerInfo.md",3494],"46669adc":[()=>n.e(51320).then(n.bind(n,60964)),"@site/api/interfaces/AuditRecord.md",60964],"46b3c144":[()=>n.e(1868).then(n.bind(n,69884)),"@site/api/interfaces/PodCreatePortOptions.md",69884],"473de3ed":[()=>n.e(19043).then(n.bind(n,16550)),"@site/docs/kubernetes/kind/pushing-an-image-to-kind.md",16550],"4780c642":[()=>n.e(83050).then(n.t.bind(n,97584,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-containerfile-bb6.json",97584],"4816649b":[()=>Promise.all([n.e(95628),n.e(26690)]).then(n.bind(n,47883)),"@site/blog/2023-04-14-release-0.14.md",47883],"48b6ff5f":[()=>n.e(37573).then(n.bind(n,89878)),"@site/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle.md",89878],"494e8e75":[()=>n.e(49076).then(n.bind(n,8812)),"@site/api/interfaces/UnregisterContainerConnectionEvent.md",8812],"4974f5d2":[()=>n.e(91447).then(n.bind(n,24912)),"@site/docs/lima/index.md",24912],"49a2e93c":[()=>n.e(18649).then(n.bind(n,2843)),"@site/api/namespaces/cli/index.md",2843],"49bee2be":[()=>n.e(80448).then(n.bind(n,88557)),"@site/api/namespaces/navigation/functions/navigateToContainers.md",88557],"49d9416a":[()=>n.e(11077).then(n.bind(n,31978)),"@site/api/namespaces/containerEngine/functions/startContainer.md",31978],"4b66c45e":[()=>n.e(78416).then(n.t.bind(n,36702,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-mac-0-s-c21.json",36702],"4b8121dd":[()=>n.e(70534).then(n.bind(n,42375)),"@site/docs/kubernetes/existing-kubernetes/index.md",42375],"4bdb36b8":[()=>n.e(11648).then(n.t.bind(n,66899,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-multi-container-c63.json",66899],"4c217c25":[()=>n.e(81900).then(n.bind(n,23697)),"@site/api/namespaces/containerEngine/functions/listContainers.md",23697],"4c5becac":[()=>n.e(74961).then(n.bind(n,65340)),"@site/api/classes/EventEmitter.md",65340],"4cb6c19a":[()=>n.e(21046).then(n.bind(n,10643)),"@site/docs/kind/index.md",10643],"4d71dffe":[()=>n.e(40816).then(n.bind(n,66360)),"@site/blog/2024-01-02-getting-started-with-compose.md",66360],"4ec4c6cd":[()=>n.e(27168).then(n.bind(n,88847)),"@site/api/namespaces/commands/index.md",88847],"4ec76dfa":[()=>n.e(80900).then(n.bind(n,1182)),"@site/api/namespaces/containerEngine/index.md",1182],"4f35c7a7":[()=>n.e(31824).then(n.t.bind(n,69485,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-windows-4ea.json",69485],"4f425ff4":[()=>n.e(89799).then(n.bind(n,45174)),"@site/api/namespaces/provider/functions/onDidUpdateContainerConnection.md",45174],"4f9d299b":[()=>n.e(51796).then(n.t.bind(n,94736,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-openshift-8fd.json",94736],"4f9e8711":[()=>n.e(27177).then(n.bind(n,23912)),"@site/api/interfaces/ProviderConnectionFactory.md",23912],"5046ea8f":[()=>n.e(75167).then(n.bind(n,55434)),"@site/api/namespaces/registry/functions/suggestRegistry.md",55434],"5087625a":[()=>Promise.all([n.e(18565),n.e(9928),n.e(11724)]).then(n.bind(n,50036)),"@site/src/pages/downloads/windows.tsx",50036],"512fbd77":[()=>n.e(50649).then(n.bind(n,96278)),"@site/blog/2023-06-08-release-1.1.md?truncated=true",96278],"51e516cc":[()=>n.e(76158).then(n.bind(n,50743)),"@site/docs/containers/creating-a-pod.md",50743],"524ce9a0":[()=>n.e(18768).then(n.bind(n,61155)),"@site/docs/kind/configuring-podman-for-kind-on-windows.md",61155],"52ea62e7":[()=>n.e(26116).then(n.t.bind(n,82006,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-docker-compose-7e7.json",82006],"54590fd2":[()=>n.e(20138).then(n.bind(n,53461)),"@site/docs/kubernetes/deploying-a-pod-to-kubernetes.md",53461],"54d805e4":[()=>n.e(33356).then(n.bind(n,63845)),"@site/api/interfaces/VolumeListInfo.md",63845],"562ca3e9":[()=>n.e(23840).then(n.bind(n,68787)),"@site/docs/kind/creating-a-kind-cluster.md",68787],"5660752d":[()=>Promise.all([n.e(40532),n.e(48176)]).then(n.bind(n,40559)),"@site/docs/openshift/openshift-local/index.md",40559],"56c3a9b2":[()=>Promise.all([n.e(18565),n.e(9928),n.e(43010)]).then(n.bind(n,55646)),"@site/src/pages/core-values/index.tsx",55646],"57a8015d":[()=>n.e(27268).then(n.bind(n,85996)),"@site/api/namespaces/navigation/functions/navigateToWebview.md",85996],"57dba496":[()=>n.e(5886).then(n.bind(n,59278)),"@site/api/interfaces/PullEvent.md",59278],"57e01cd5":[()=>n.e(43546).then(n.bind(n,39734)),"@site/api/type-aliases/StatusBarAlignment.md",39734],"583db3ef":[()=>n.e(67363).then(n.bind(n,55881)),"@site/docs/extensions/index.md",55881],"591f7a5f":[()=>n.e(76357).then(n.t.bind(n,21442,19)),"@generated/docusaurus-plugin-content-docs/api/p/api-95a.json",21442],"59a6f192":[()=>n.e(33233).then(n.bind(n,7706)),"@site/docs/containers/onboarding.md",7706],"5a3b561f":[()=>n.e(56870).then(n.bind(n,6151)),"@site/blog/2024-02-20-podman-desktop-wins-devies-award.md",6151],"5a7aef43":[()=>n.e(59081).then(n.bind(n,68341)),"@site/api/namespaces/navigation/functions/navigateToImages.md",68341],"5a9a7a02":[()=>n.e(89472).then(n.bind(n,27807)),"@site/api/namespaces/containerEngine/functions/deleteVolume.md",27807],"5b10a003":[()=>n.e(28437).then(n.bind(n,78997)),"@site/api/interfaces/BlkioStats.md",78997],"5b7d9ef2":[()=>n.e(86112).then(n.bind(n,65941)),"@site/api/type-aliases/KubernetesGeneratorType.md",65941],"5bc09a53":[()=>n.e(79649).then(n.bind(n,43844)),"@site/api/interfaces/HealthConfig.md",43844],"5c0f0993":[()=>n.e(5674).then(n.bind(n,79003)),"@site/api/interfaces/TelemetrySender.md",79003],"5c25e6fa":[()=>n.e(67539).then(n.bind(n,78443)),"@site/api/namespaces/navigation/index.md",78443],"5db8318c":[()=>n.e(58792).then(n.bind(n,58718)),"@site/api/namespaces/commands/functions/registerCommand.md",58718],"5df556a2":[()=>Promise.all([n.e(95628),n.e(83870)]).then(n.bind(n,86489)),"@site/blog/2023-05-02-release-0.15.md",86489],"5e30269e":[()=>n.e(27135).then(n.bind(n,81619)),"@site/api/type-aliases/ProviderStatus.md",81619],"5e486140":[()=>n.e(26557).then(n.bind(n,6974)),"@site/api/namespaces/containerEngine/functions/listPods.md",6974],"5e8fbcdf":[()=>n.e(5417).then(n.bind(n,28786)),"@site/api/interfaces/BuildImageOptions.md",28786],"5e95c892":[()=>n.e(29661).then(n.bind(n,32108)),"@theme/DocsRoot",32108],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,36809)),"@generated/docusaurus.config",36809],"5ebdf64d":[()=>n.e(30720).then(n.t.bind(n,3710,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-compose-848.json",3710],"5fb93fc0":[()=>n.e(28813).then(n.bind(n,44267)),"@site/docs/extensions/api/index.md",44267],"604e05e4":[()=>n.e(62871).then(n.bind(n,98771)),"@site/api/interfaces/NetworkInfo.md",98771],"60c82955":[()=>n.e(48926).then(n.bind(n,92095)),"@site/api/interfaces/CliTool.md",92095],"6101b3fc":[()=>Promise.all([n.e(18565),n.e(9928),n.e(65248)]).then(n.bind(n,93963)),"@site/src/pages/downloads/linux.tsx",93963],"610f2c47":[()=>n.e(23937).then(n.bind(n,19355)),"@site/api/namespaces/window/functions/showInputBox.md",19355],"612345e6":[()=>n.e(47389).then(n.bind(n,8846)),"@site/api/namespaces/navigation/functions/navigateToContribution.md",8846],"6269f1c0":[()=>Promise.all([n.e(40532),n.e(10138)]).then(n.bind(n,70949)),"@site/docs/migrating-from-docker/importing-saved-containers.md",70949],"62e21724":[()=>n.e(33067).then(n.bind(n,38536)),"@site/api/interfaces/QuickInputButton.md",38536],"640277b9":[()=>n.e(48901).then(n.bind(n,18630)),"@site/api/namespaces/window/functions/listWebviews.md",18630],"64134c03":[()=>n.e(71796).then(n.bind(n,28)),"@site/api/namespaces/proxy/functions/isEnabled.md",28],"6477cdc2":[()=>n.e(16696).then(n.bind(n,52321)),"@site/api/namespaces/env/functions/createTelemetryLogger.md",52321],"6494b798":[()=>n.e(41619).then(n.bind(n,92650)),"@site/api/namespaces/env/variables/isWindows.md",92650],"64abd3af":[()=>n.e(745).then(n.bind(n,36397)),"@site/docs/kind/pushing-an-image-to-kind.md",36397],"64bd32f2":[()=>n.e(76192).then(n.bind(n,11197)),"@site/api/namespaces/containerEngine/functions/inspectManifest.md",11197],"65a10ffa":[()=>n.e(32472).then(n.bind(n,99867)),"@site/blog/2023-03-24-5-things-to-know-for-a-docker-user.md?truncated=true",99867],"6603ef13":[()=>n.e(3207).then(n.bind(n,11419)),"@site/docs/installation/index.md",11419],67386898:[()=>n.e(20406).then(n.bind(n,39607)),"@site/api/interfaces/VolumeCreateOptions.md",39607],"6763d4e0":[()=>n.e(84513).then(n.bind(n,23558)),"@site/api/namespaces/containerEngine/functions/info.md",23558],"6774f806":[()=>n.e(35572).then(n.bind(n,81117)),"@site/api/namespaces/containerEngine/functions/pullImage.md",81117],"67eba1be":[()=>n.e(52950).then(n.bind(n,70166)),"@site/api/interfaces/Command.md",70166],"67fccd64":[()=>n.e(77319).then(n.bind(n,33837)),"@site/api/interfaces/ContainerStatsInfo.md",33837],"6864e844":[()=>n.e(47718).then(n.bind(n,10910)),"@site/docs/extensions/developing/onboarding-workflow.md",10910],"6875c492":[()=>Promise.all([n.e(40532),n.e(18565),n.e(9928),n.e(10787),n.e(99086),n.e(48610)]).then(n.bind(n,41071)),"@theme/BlogTagsPostsPage",41071],"688ee267":[()=>n.e(17708).then(n.bind(n,61733)),"@site/api/namespaces/authentication/functions/onDidChangeSessions.md",61733],"69c5f318":[()=>n.e(34322).then(n.bind(n,21746)),"@site/docs/kind/working-with-your-local-kind-cluster.md",21746],"6a1fe514":[()=>n.e(96017).then(n.bind(n,70908)),"@site/api/interfaces/RegistrySuggestedProvider.md",70908],"6aa0b043":[()=>n.e(84507).then(n.bind(n,28923)),"@site/api/interfaces/ProviderContainerConnection.md",28923],"6bf124c2":[()=>n.e(98960).then(n.bind(n,40836)),"@site/docs/minikube/deleting-your-minikube-cluster.md",40836],"6c80b6fe":[()=>n.e(12323).then(n.bind(n,52646)),"@site/docs/troubleshooting/troubleshooting-podman-on-linux.md",52646],"6e30ac7b":[()=>n.e(57368).then(n.bind(n,91803)),"@site/api/interfaces/QuickPickOptions.md",91803],"6e92edd9":[()=>n.e(63652).then(n.bind(n,26589)),"@site/api/interfaces/Configuration.md",26589],"6eafe0c7":[()=>n.e(88089).then(n.bind(n,87532)),"@site/api/interfaces/EndpointSettings.md",87532],"6eb49eac":[()=>n.e(728).then(n.t.bind(n,66809,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-extensions-713.json",66809],"708d858d":[()=>n.e(7377).then(n.bind(n,66798)),"@site/docs/migrating-from-docker/emulating-docker-cli-with-podman.md",66798],"70e3b13c":[()=>n.e(25817).then(n.bind(n,2656)),"@site/api/namespaces/registry/functions/registerRegistry.md",2656],"7144043e":[()=>n.e(69783).then(n.t.bind(n,46737,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-docker-e41.json",46737],"714e70d1":[()=>n.e(648).then(n.bind(n,80071)),"@site/api/interfaces/ProviderEvent.md",80071],71748509:[()=>n.e(97227).then(n.bind(n,17001)),"@site/api/namespaces/registry/functions/unregisterRegistry.md",17001],"724f3974":[()=>n.e(5414).then(n.bind(n,46313)),"@site/docs/minikube/configuring-podman-for-minikube-on-windows.md",46313],"7258860f":[()=>n.e(92423).then(n.bind(n,87064)),"@site/api/namespaces/containerEngine/functions/logsContainer.md",87064],"732d4d9b":[()=>n.e(15150).then(n.bind(n,28017)),"@site/blog/2024-02-20-podman-desktop-wins-devies-award.md?truncated=true",28017],"73f18a6f":[()=>n.e(14499).then(n.bind(n,46403)),"@site/api/namespaces/provider/functions/createProvider.md",46403],"73f9658e":[()=>n.e(61305).then(n.bind(n,34683)),"@site/api/namespaces/containerEngine/functions/pushImage.md",34683],"74b658de":[()=>n.e(62283).then(n.bind(n,96350)),"@site/api/namespaces/containerEngine/functions/removePod.md",96350],"74c26f41":[()=>n.e(59186).then(n.t.bind(n,72175,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-images-e8f.json",72175],"7500e360":[()=>n.e(86272).then(n.bind(n,7809)),"@site/api/namespaces/window/functions/showSaveDialog.md",7809],75281220:[()=>n.e(57366).then(n.bind(n,1079)),"@site/docs/kubernetes/index.md",1079],"7547d3bb":[()=>n.e(45835).then(n.bind(n,99145)),"@site/api/interfaces/ProviderCleanup.md",99145],"786fee93":[()=>n.e(7371).then(n.bind(n,26440)),"@site/api/namespaces/env/variables/isLinux.md",26440],"78b70dba":[()=>n.e(2408).then(n.t.bind(n,56633,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-flatpak-33f.json",56633],"79f18c88":[()=>n.e(36006).then(n.bind(n,66472)),"@site/api/interfaces/ContainerAuthInfo.md",66472],"7a21ccb0":[()=>n.e(72996).then(n.bind(n,18837)),"@site/api/namespaces/registry/index.md",18837],"7a957b04":[()=>n.e(58739).then(n.bind(n,48876)),"@site/blog/2023-12-18-release-1.6.md",48876],"7aa856d6":[()=>n.e(886).then(n.bind(n,56886)),"@site/api/variables/version.md",56886],"7afa6340":[()=>n.e(10588).then(n.bind(n,73486)),"@site/blog/2024-01-24-release-1.7.md?truncated=true",73486],"7b477840":[()=>n.e(42326).then(n.bind(n,84749)),"@site/api/namespaces/provider/index.md",84749],"7be672a3":[()=>n.e(53691).then(n.bind(n,47208)),"@site/docs/kubernetes/minikube/pushing-an-image-to-minikube.md",47208],"7bef3f04":[()=>n.e(24498).then(n.bind(n,7346)),"@site/api/namespaces/provider/functions/onDidRegisterContainerConnection.md",7346],"7c7a772e":[()=>n.e(77060).then(n.bind(n,44215)),"@site/api/interfaces/WebviewPanel.md",44215],"7cde3c49":[()=>n.e(37836).then(n.bind(n,30393)),"@site/api/interfaces/VolumeDeleteOptions.md",30393],"7d3ae564":[()=>n.e(32360).then(n.t.bind(n,15324,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-containers-d37.json",15324],"7d88b63f":[()=>n.e(17741).then(n.bind(n,81728)),"@site/docs/troubleshooting/troubleshooting-openshift-local.md",81728],"7d9edfb8":[()=>n.e(90125).then(n.bind(n,38654)),"@site/api/namespaces/containerEngine/functions/listImages.md",38654],"7e2ae3df":[()=>n.e(28143).then(n.bind(n,38230)),"@site/api/namespaces/authentication/functions/registerAuthenticationProvider.md",38230],"7e5a2776":[()=>n.e(51171).then(n.bind(n,40733)),"@site/api/interfaces/FileSystemWatcher.md",40733],"7e93d479":[()=>n.e(22978).then(n.bind(n,5959)),"@site/docs/extensions/developing/commands.md",5959],"7f0476bd":[()=>n.e(45346).then(n.bind(n,7095)),"@site/api/interfaces/Webview.md",7095],"7fa133e1":[()=>n.e(31512).then(n.bind(n,28204)),"@site/api/interfaces/CustomPickItem.md",28204],"814402d7":[()=>n.e(70985).then(n.bind(n,87574)),"@site/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent.md",87574],"814d49b7":[()=>n.e(125).then(n.bind(n,52994)),"@site/api/interfaces/CliToolUpdateOptions.md",52994],"814f3328":[()=>n.e(52535).then(n.t.bind(n,45641,19)),"~blog/default/blog-post-list-prop-default.json",45641],"815c93fd":[()=>n.e(38684).then(n.bind(n,1e3)),"@site/docs/ai-lab/installing.md",1e3],"81b69ac7":[()=>n.e(92786).then(n.bind(n,49911)),"@site/api/interfaces/KubernetesProviderConnectionFactory.md",49911],"81e486a8":[()=>n.e(89626).then(n.bind(n,79148)),"@site/docs/kind/restarting-your-kind-cluster.md",79148],"82170cf7":[()=>n.e(28263).then(n.bind(n,38185)),"@site/api/namespaces/containerEngine/functions/getImageInspect.md",38185],"825ec378":[()=>n.e(83039).then(n.bind(n,91525)),"@site/api/namespaces/containerEngine/functions/buildImage.md",91525],"83245ae6":[()=>Promise.all([n.e(95628),n.e(47679)]).then(n.bind(n,24900)),"@site/blog/2023-01-18-release-0.11.md",24900],"8519c2b0":[()=>n.e(40569).then(n.bind(n,93020)),"@site/api/namespaces/window/functions/showErrorMessage.md",93020],"86063cd3":[()=>n.e(92958).then(n.bind(n,5872)),"@site/docs/lima/customizing.md",5872],"8677f412":[()=>n.e(6102).then(n.bind(n,51310)),"@site/api/namespaces/imageChecker/index.md",51310],"86e64757":[()=>n.e(36075).then(n.bind(n,87321)),"@site/api/namespaces/env/variables/isTelemetryEnabled.md",87321],"86f2a982":[()=>Promise.all([n.e(40532),n.e(40070)]).then(n.bind(n,97261)),"@site/docs/troubleshooting/troubleshooting-podman.md",97261],"86f8c256":[()=>n.e(29234).then(n.bind(n,57895)),"@site/api/interfaces/ImageInspectInfo.md",57895],"871ce139":[()=>n.e(91893).then(n.bind(n,15371)),"@site/api/interfaces/NetworkCreateOptions.md",15371],"874690d0":[()=>n.e(58216).then(n.bind(n,72077)),"@site/api/interfaces/StatusBarItem.md",72077],"8785b74d":[()=>n.e(83672).then(n.bind(n,32084)),"@site/api/interfaces/TelemetryLogger.md",32084],"878aa0e7":[()=>n.e(16467).then(n.bind(n,55606)),"@site/api/type-aliases/ConfigurationScope.md",55606],"87a5fc8a":[()=>n.e(61573).then(n.bind(n,81089)),"@site/api/interfaces/PidsStats.md",81089],"883e2c3c":[()=>n.e(53479).then(n.bind(n,70830)),"@site/api/namespaces/containerEngine/functions/startPod.md",70830],"8873cf50":[()=>n.e(10485).then(n.bind(n,16472)),"@site/blog/2024-01-02-getting-started-with-compose.md?truncated=true",16472],"894e67a6":[()=>n.e(73714).then(n.bind(n,35392)),"@site/blog/2023-09-18-release-1.4.md?truncated=true",35392],"898514b1":[()=>n.e(3954).then(n.t.bind(n,285,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-e58.json",285],"8a864d1e":[()=>n.e(68974).then(n.bind(n,97197)),"@site/api/type-aliases/ProviderConnectionStatus.md",97197],"8abd0ba5":[()=>n.e(1516).then(n.bind(n,8972)),"@site/api/interfaces/CustomPickSectionItem.md",8972],"8ae04122":[()=>n.e(21534).then(n.bind(n,2665)),"@site/blog/2024-04-05-release-1.9.md?truncated=true",2665],"8b4ba22f":[()=>n.e(60564).then(n.bind(n,346)),"@site/api/interfaces/CliToolUpdate.md",346],"8b4dd820":[()=>n.e(73636).then(n.bind(n,84066)),"@site/blog/2022-12-01-release-0.10-blog.md?truncated=true",84066],"8be8ac58":[()=>n.e(75809).then(n.t.bind(n,65986,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-ai-848.json",65986],"8c6c72f9":[()=>n.e(63707).then(n.bind(n,50243)),"@site/api/type-aliases/CheckResultLink.md",50243],"8c8ef21f":[()=>n.e(80954).then(n.bind(n,46629)),"@site/api/interfaces/Link.md",46629],"8ca0e442":[()=>n.e(83687).then(n.t.bind(n,67608,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-award-4a6.json",67608],"8cb0269b":[()=>n.e(35281).then(n.bind(n,88782)),"@site/api/classes/Uri.md",88782],"8ccdb99f":[()=>n.e(6639).then(n.bind(n,38630)),"@site/api/type-aliases/MountConsistency.md",38630],"8dbb6800":[()=>n.e(46738).then(n.bind(n,62926)),"@site/api/namespaces/containerEngine/functions/listVolumes.md",62926],"8e49e0b0":[()=>n.e(11121).then(n.t.bind(n,35140,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-devcontainer-d1c.json",35140],"8eeedb31":[()=>n.e(28682).then(n.bind(n,32799)),"@site/api/interfaces/WebviewPanelOnDidChangeViewStateEvent.md",32799],"8fe4c488":[()=>n.e(89338).then(n.t.bind(n,75526,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-story-5ea.json",75526],"901c37e5":[()=>n.e(61021).then(n.bind(n,37197)),"@site/docs/minikube/working-with-your-local-minikube-cluster.md",37197],"905702d2":[()=>n.e(38056).then(n.bind(n,29700)),"@site/api/namespaces/tray/functions/registerMenuItem.md",29700],91008145:[()=>n.e(42423).then(n.bind(n,87811)),"@site/api/namespaces/containerEngine/functions/listNetworks.md",87811],91392348:[()=>n.e(60637).then(n.bind(n,47084)),"@site/api/interfaces/UnregisterKubernetesConnectionEvent.md",47084],"91a39dd0":[()=>n.e(80957).then(n.t.bind(n,7057,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-docker-eea.json",7057],"91fe1403":[()=>n.e(92916).then(n.bind(n,53968)),"@site/api/namespaces/env/variables/clipboard.md",53968],"920c2ac2":[()=>n.e(2281).then(n.bind(n,6207)),"@site/api/interfaces/MemoryStats.md",6207],"927c84a6":[()=>n.e(8039).then(n.bind(n,78986)),"@site/api/interfaces/CheckResultFixCommand.md",78986],"9286a297":[()=>n.e(21360).then(n.bind(n,98563)),"@site/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection.md",98563],"92b08985":[()=>n.e(57321).then(n.bind(n,3849)),"@site/api/interfaces/NetworkContainer.md",3849],"92d7df62":[()=>n.e(2353).then(n.bind(n,61654)),"@site/api/interfaces/Auditor.md",61654],"931e3b0a":[()=>n.e(55904).then(n.bind(n,9958)),"@site/api/interfaces/PortBinding.md",9958],"93e05602":[()=>n.e(99494).then(n.bind(n,89792)),"@site/api/namespaces/configuration/index.md",89792],"94324b0e":[()=>n.e(76267).then(n.bind(n,73726)),"@site/api/namespaces/containerEngine/functions/createVolume.md",73726],"94f3d131":[()=>n.e(64651).then(n.bind(n,26088)),"@site/docs/minikube/restarting-your-minikube-cluster.md",26088],95366386:[()=>n.e(34617).then(n.bind(n,80587)),"@site/blog/2023-05-02-release-0.15.md?truncated=true",80587],"9542c76a":[()=>n.e(24483).then(n.t.bind(n,74029,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-flathub-2d3.json",74029],"95646edb":[()=>n.e(66e3).then(n.bind(n,81867)),"@site/api/namespaces/containerEngine/functions/onEvent.md",81867],"9684f8b7":[()=>n.e(66743).then(n.bind(n,27947)),"@site/docs/extensions/developing/command-palette.md",27947],"97615df2":[()=>Promise.all([n.e(95628),n.e(65375)]).then(n.bind(n,61980)),"@site/blog/2023-07-12-release-1.2.md?truncated=true",61980],"97a89ac0":[()=>Promise.all([n.e(18565),n.e(1782)]).then(n.bind(n,23539)),"@site/src/pages/extensions/ai-lab/index.tsx",23539],"97c7db18":[()=>n.e(52343).then(n.bind(n,2610)),"@site/api/namespaces/navigation/functions/navigateToContainerInspect.md",2610],"97d49594":[()=>n.e(45708).then(n.bind(n,42200)),"@site/api/namespaces/containerEngine/functions/inspectContainer.md",42200],"97eb992d":[()=>n.e(53800).then(n.bind(n,85506)),"@site/api/interfaces/NetworkInspectInfo.md",85506],"98ced590":[()=>n.e(80325).then(n.bind(n,62282)),"@site/api/namespaces/navigation/functions/navigateToContainerTerminal.md",62282],"9a22c80d":[()=>n.e(92428).then(n.bind(n,284)),"@site/api/namespaces/extensions/variables/all.md",284],"9af13eab":[()=>n.e(45033).then(n.bind(n,11573)),"@site/api/namespaces/provider/functions/getContainerConnections.md",11573],"9c540f0b":[()=>n.e(14026).then(n.bind(n,99460)),"@site/api/interfaces/MountSettings.md",99460],"9d2d4743":[()=>n.e(89731).then(n.bind(n,90190)),"@site/api/interfaces/ContainerProviderConnectionEndpoint.md",90190],"9d887a11":[()=>n.e(24904).then(n.bind(n,65005)),"@site/api/namespaces/window/functions/createWebviewPanel.md",65005],"9db962b6":[()=>n.e(41644).then(n.bind(n,11716)),"@site/api/namespaces/provider/functions/onDidUpdateKubernetesConnection.md",11716],"9dce5486":[()=>n.e(88566).then(n.bind(n,53252)),"@site/blog/2023-02-15-release-0.12.md",53252],"9dd60997":[()=>n.e(76518).then(n.bind(n,79961)),"@site/api/namespaces/authentication/functions/getSession.md",79961],"9e4087bc":[()=>n.e(53608).then(n.bind(n,7507)),"@theme/BlogArchivePage",7507],"9e8f4e9c":[()=>n.e(1074).then(n.bind(n,11760)),"@site/docs/extensions/install/index.md",11760],"9f2f2cb3":[()=>n.e(17194).then(n.bind(n,98985)),"@site/blog/2024-03-07-release-1.8.md?truncated=true",98985],"9f90a44b":[()=>n.e(83945).then(n.t.bind(n,42428,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-onboarding-967.json",42428],"9f97f9d1":[()=>Promise.all([n.e(95628),n.e(56843)]).then(n.bind(n,31482)),"@site/blog/2023-08-16-release-1.3.md?truncated=true",31482],a00af9f0:[()=>Promise.all([n.e(95628),n.e(822)]).then(n.bind(n,5416)),"@site/blog/2023-11-03-release-1.5.md",5416],a0323d9f:[()=>n.e(523).then(n.bind(n,48891)),"@site/docs/minikube/pushing-an-image-to-minikube.md",48891],a08dfa31:[()=>n.e(69006).then(n.bind(n,34649)),"@site/api/interfaces/ProviderOptions.md",34649],a0c37fdd:[()=>n.e(86258).then(n.t.bind(n,38918,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-compose-5a4.json",38918],a2c6f402:[()=>n.e(6266).then(n.bind(n,96550)),"@site/api/type-aliases/ProviderLinks.md",96550],a2d1ff94:[()=>n.e(41169).then(n.bind(n,89703)),"@site/api/interfaces/ContainerProviderConnection.md",89703],a2ffcc0f:[()=>n.e(51843).then(n.bind(n,15382)),"@site/api/namespaces/kubernetes/functions/registerKubernetesGenerator.md",15382],a3002291:[()=>n.e(36424).then(n.bind(n,34403)),"@site/api/namespaces/containerEngine/functions/createNetwork.md",34403],a30c0d44:[()=>n.e(64891).then(n.bind(n,16927)),"@site/api/interfaces/InputBoxOptions.md",16927],a334b453:[()=>n.e(4004).then(n.bind(n,62806)),"@site/api/interfaces/UpdateContainerConnectionEvent.md",62806],a33d13d7:[()=>n.e(61476).then(n.t.bind(n,51342,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-images-181.json",51342],a35cf155:[()=>n.e(59341).then(n.bind(n,95569)),"@site/docs/installation/windows-install/index.md",95569],a38d285e:[()=>n.e(86477).then(n.bind(n,58782)),"@site/api/interfaces/RegisterContainerConnectionEvent.md",58782],a3f8794a:[()=>n.e(60334).then(n.bind(n,20120)),"@site/api/namespaces/containerEngine/functions/createContainer.md",20120],a4794f2e:[()=>n.e(11161).then(n.bind(n,21926)),"@site/api/namespaces/registry/functions/registerRegistryProvider.md",21926],a6aa9e1f:[()=>Promise.all([n.e(40532),n.e(18565),n.e(9928),n.e(10787),n.e(99086),n.e(93089)]).then(n.bind(n,8787)),"@theme/BlogListPage",8787],a7456010:[()=>n.e(15980).then(n.t.bind(n,79365,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",79365],a7777682:[()=>n.e(97002).then(n.bind(n,12629)),"@site/api/namespaces/extensions/index.md",12629],a7bd4aaa:[()=>n.e(18518).then(n.bind(n,84987)),"@theme/DocVersionRoot",84987],a826efc5:[()=>n.e(96514).then(n.bind(n,14875)),"@site/blog/2024-01-24-release-1.7.md",14875],a847366a:[()=>n.e(13893).then(n.t.bind(n,85762,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-podman-08a.json",85762],a8ce95ee:[()=>n.e(97159).then(n.bind(n,20268)),"@site/docs/containers/images/pulling-an-image.md",20268],a943bcee:[()=>n.e(10379).then(n.bind(n,18258)),"@site/api/interfaces/NetworkStats.md",18258],a94703ab:[()=>Promise.all([n.e(40532),n.e(94368)]).then(n.bind(n,53505)),"@theme/DocRoot",53505],a9bc0f5d:[()=>n.e(24787).then(n.t.bind(n,30819,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-lima-129.json",30819],a9fa5b1f:[()=>n.e(44619).then(n.bind(n,51880)),"@site/api/interfaces/ProviderCleanupAction.md",51880],aaabcfd8:[()=>n.e(76932).then(n.bind(n,72182)),"@site/docs/lima/creating-a-kubernetes-instance.md",72182],ab69fe56:[()=>n.e(25314).then(n.bind(n,7641)),"@site/api/type-aliases/MountConfig.md",7641],aba21aa0:[()=>n.e(33629).then(n.t.bind(n,41765,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",41765],aba485c2:[()=>n.e(30821).then(n.bind(n,11986)),"@site/blog/2024-04-30-release-1.10.md?truncated=true",11986],abc85917:[()=>n.e(72896).then(n.bind(n,61112)),"@site/docs/compose/setting-up-compose.md",61112],aca8b082:[()=>n.e(272).then(n.bind(n,157)),"@site/docs/extensions/developing/config.md",157],acecf23e:[()=>n.e(97393).then(n.t.bind(n,81838,19)),"~blog/default/blogMetadata-default.json",81838],ada86621:[()=>n.e(75862).then(n.bind(n,18766)),"@site/api/namespaces/env/index.md",18766],adb00d9a:[()=>n.e(10717).then(n.t.bind(n,48481,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-llm-eb0.json",48481],adcef0a2:[()=>n.e(66464).then(n.bind(n,69741)),"@site/api/interfaces/ImageCheckerProvider.md",69741],adfdec4a:[()=>n.e(71970).then(n.bind(n,94053)),"@site/api/interfaces/CustomPick.md",94053],ae4a775b:[()=>n.e(30901).then(n.bind(n,54280)),"@site/api/namespaces/context/functions/setValue.md",54280],ae79aff5:[()=>n.e(24386).then(n.bind(n,50226)),"@site/docs/migrating-from-docker/index.md",50226],af231220:[()=>n.e(45326).then(n.bind(n,8466)),"@site/docs/kind/installing.md",8466],b104dd1e:[()=>n.e(46623).then(n.bind(n,96257)),"@site/docs/compose/running-compose.md",96257],b15eeff9:[()=>n.e(67411).then(n.bind(n,37749)),"@site/api/interfaces/AuthenticationSessionAccountInformation.md",37749],b2973dc4:[()=>n.e(77911).then(n.t.bind(n,94726,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-writing-566.json",94726],b39cdcf9:[()=>n.e(40592).then(n.bind(n,8756)),"@site/blog/2023-03-24-5-things-to-know-for-a-docker-user.md",8756],b3b7dd16:[()=>n.e(84960).then(n.bind(n,15614)),"@site/api/namespaces/window/functions/createCustomPick.md",15614],b4df9b48:[()=>n.e(35425).then(n.bind(n,91258)),"@site/api/interfaces/Registry.md",91258],b5114993:[()=>n.e(54373).then(n.bind(n,48444)),"@site/api/classes/Disposable.md",48444],b51a9aee:[()=>n.e(39620).then(n.bind(n,42154)),"@site/api/namespaces/navigation/functions/navigateToVolumes.md",42154],b52d840d:[()=>n.e(35584).then(n.bind(n,26317)),"@site/api/interfaces/VolumeInfo.md",26317],b5b19789:[()=>n.e(80355).then(n.bind(n,40508)),"@site/api/variables/StatusBarAlignRight.md",40508],b5ec5208:[()=>n.e(92514).then(n.bind(n,45617)),"@site/api/namespaces/provider/functions/onDidUpdateProvider.md",45617],b66ca8cf:[()=>n.e(42205).then(n.bind(n,94022)),"@site/api/namespaces/registry/functions/onDidUnregisterRegistry.md",94022],b678a236:[()=>n.e(37245).then(n.bind(n,3707)),"@site/api/namespaces/containerEngine/functions/stopContainer.md",3707],b6be2912:[()=>n.e(82424).then(n.bind(n,62461)),"@site/api/namespaces/window/functions/showWarningMessage.md",62461],b6d76a6c:[()=>n.e(3667).then(n.bind(n,83285)),"@site/api/namespaces/proxy/functions/onDidStateChange.md",83285],b7746a44:[()=>n.e(75697).then(n.bind(n,89017)),"@site/docs/extensions/developing/adding-icons.md",89017],b799648a:[()=>n.e(11981).then(n.bind(n,92445)),"@site/blog/2023-05-17-release-1.0.md?truncated=true",92445],b7bb2d93:[()=>n.e(16855).then(n.bind(n,13075)),"@site/api/enumerations/ProgressLocation.md",13075],b8eb0fce:[()=>n.e(69584).then(n.bind(n,4061)),"@site/api/namespaces/registry/functions/onDidRegisterRegistry.md",4061],b8ec852b:[()=>n.e(63407).then(n.bind(n,73444)),"@site/api/interfaces/ProgressOptions.md",73444],b9287eb6:[()=>n.e(89251).then(n.bind(n,16913)),"@site/api/interfaces/CPUUsage.md",16913],b985118d:[()=>n.e(899).then(n.bind(n,31513)),"@site/docs/installation/macos-install.md",31513],b9a87183:[()=>n.e(25821).then(n.bind(n,91182)),"@site/api/interfaces/AuthenticationProviderInformation.md",91182],ba5b9f11:[()=>n.e(97251).then(n.bind(n,50896)),"@site/blog/2022-11-17-develop-podman-using-codespaces.md?truncated=true",50896],bab44fba:[()=>n.e(98170).then(n.bind(n,51971)),"@site/api/namespaces/containerEngine/functions/replicatePodmanContainer.md",51971],bb6a5560:[()=>n.e(2883).then(n.bind(n,36)),"@site/api/namespaces/proxy/functions/getProxySettings.md",36],bbf561d5:[()=>n.e(82388).then(n.bind(n,65987)),"@site/api/namespaces/kubernetes/index.md",65987],bc816bf2:[()=>n.e(10347).then(n.bind(n,46965)),"@site/docs/podman/index.md",46965],bc873533:[()=>n.e(10038).then(n.bind(n,1586)),"@site/api/interfaces/PortMap.md",1586],bd45720e:[()=>n.e(13239).then(n.bind(n,54066)),"@site/api/namespaces/navigation/functions/navigateToContainer.md",54066],bd65ec7e:[()=>n.e(41798).then(n.bind(n,83934)),"@site/api/namespaces/kubernetes/functions/createResources.md",83934],bd80aa65:[()=>n.e(23427).then(n.bind(n,18980)),"@site/docs/kind/deleting-your-kind-cluster.md",18980],bdb8b81b:[()=>n.e(57549).then(n.bind(n,20484)),"@site/api/interfaces/StorageStats.md",20484],be228752:[()=>n.e(13573).then(n.bind(n,80699)),"@site/api/namespaces/navigation/functions/navigateToPod.md",80699],bf11c6a2:[()=>n.e(75290).then(n.bind(n,78608)),"@site/api/interfaces/RegistryCreateOptions.md",78608],c09ab32f:[()=>n.e(29112).then(n.bind(n,18740)),"@site/api/variables/StatusBarAlignLeft.md",18740],c0c3bda5:[()=>n.e(44654).then(n.t.bind(n,67366,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-wasi-0a7.json",67366],c104141c:[()=>n.e(26348).then(n.bind(n,50341)),"@site/api/interfaces/ProviderAutostart.md",50341],c11c87f7:[()=>n.e(84940).then(n.bind(n,38575)),"@site/docs/openshift/index.md",38575],c141421f:[()=>n.e(31004).then(n.t.bind(n,51324,19)),"@generated/docusaurus-theme-search-algolia/default/__plugin.json",51324],c1584a80:[()=>n.e(19537).then(n.bind(n,31917)),"@site/api/interfaces/Logger.md",31917],c15d9823:[()=>n.e(6642).then(n.t.bind(n,92506,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-bd9.json",92506],c1ca9e21:[()=>n.e(17285).then(n.bind(n,17487)),"@site/api/interfaces/KubeconfigUpdateEvent.md",17487],c239db97:[()=>n.e(62789).then(n.bind(n,24342)),"@site/api/namespaces/containerEngine/functions/saveImage.md",24342],c25913f3:[()=>n.e(16311).then(n.bind(n,85626)),"@site/api/interfaces/InputBoxValidationMessage.md",85626],c2865a15:[()=>n.e(93401).then(n.bind(n,74193)),"@site/api/type-aliases/MountType.md",74193],c2e1e282:[()=>n.e(78127).then(n.t.bind(n,73335,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-installing-d04.json",73335],c358ebbc:[()=>n.e(27910).then(n.bind(n,98358)),"@site/api/interfaces/AuthenticationProvider.md",98358],c361d244:[()=>n.e(41869).then(n.bind(n,66334)),"@site/docs/ai-lab/start-recipe.md",66334],c44aa824:[()=>n.e(85376).then(n.bind(n,89245)),"@site/docs/podman/accessing-podman-from-another-wsl-instance.md",89245],c544b2d7:[()=>n.e(75689).then(n.bind(n,72299)),"@site/api/interfaces/ListImagesOptions.md",72299],c5b2f0f9:[()=>n.e(2193).then(n.bind(n,3284)),"@site/docs/containers/images/pushing-an-image-to-a-registry.md",3284],c6346fcf:[()=>n.e(63154).then(n.bind(n,32461)),"@site/docs/installation/linux-install/index.md",32461],c6aad055:[()=>n.e(60203).then(n.bind(n,8908)),"@site/docs/containers/index.md",8908],c71cae97:[()=>n.e(72491).then(n.bind(n,48133)),"@site/api/namespaces/process/index.md",48133],c7cac05f:[()=>n.e(73867).then(n.bind(n,66013)),"@site/api/interfaces/OpenDialogOptions.md",66013],c813bd67:[()=>n.e(82163).then(n.bind(n,9762)),"@site/api/interfaces/IPAM.md",9762],c8eb055e:[()=>n.e(79268).then(n.bind(n,81519)),"@site/docs/ai-lab/create-playground.md",81519],c9cac9d9:[()=>n.e(36325).then(n.t.bind(n,91305,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-release-6bd.json",91305],ca1234c1:[()=>n.e(77401).then(n.bind(n,23783)),"@site/api/interfaces/TelemetryLoggerOptions.md",23783],ca165b51:[()=>n.e(68059).then(n.bind(n,89508)),"@site/api/interfaces/ProxySettings.md",89508],ca6c9efa:[()=>n.e(8335).then(n.t.bind(n,10578,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-podman-bae.json",10578],cabda5f8:[()=>n.e(20873).then(n.bind(n,7278)),"@site/blog/2023-03-29-release-0.13.md?truncated=true",7278],caddb1c0:[()=>n.e(96987).then(n.bind(n,99950)),"@site/api/interfaces/ProviderConnectionLifecycle.md",99950],cb0f21df:[()=>n.e(6098).then(n.bind(n,14202)),"@site/api/interfaces/UpdateKubernetesConnectionEvent.md",14202],cc6d9416:[()=>n.e(71874).then(n.bind(n,2958)),"@site/api/interfaces/AuthConfig.md",2958],cc922df3:[()=>n.e(53273).then(n.bind(n,71270)),"@site/api/interfaces/AuthenticationGetSessionOptions.md",71270],ccc49370:[()=>Promise.all([n.e(40532),n.e(18565),n.e(9928),n.e(10787),n.e(99086),n.e(46103)]).then(n.bind(n,3389)),"@theme/BlogPostPage",3389],cd23aec9:[()=>Promise.all([n.e(40532),n.e(37698)]).then(n.bind(n,71158)),"@site/docs/proxy/index.md",71158],cd343213:[()=>n.e(73163).then(n.bind(n,30381)),"@site/docs/extensions/developing/index.md",30381],cd7fa15a:[()=>n.e(53604).then(n.bind(n,47803)),"@site/api/namespaces/proxy/index.md",47803],cdf64ea9:[()=>n.e(90681).then(n.bind(n,44337)),"@site/api/interfaces/RunError.md",44337],cfdfe126:[()=>n.e(64471).then(n.bind(n,86579)),"@site/api/namespaces/window/functions/showInformationMessage.md",86579],d103759a:[()=>n.e(65191).then(n.bind(n,70093)),"@site/api/namespaces/window/functions/createStatusBarItem.md",70093],d1163e47:[()=>n.e(59860).then(n.bind(n,50575)),"@site/api/interfaces/ImageCheckerProviderMetadata.md",50575],d1462701:[()=>n.e(62325).then(n.bind(n,92602)),"@site/docs/extensions/developing/when-clause-context.md",92602],d178b2c6:[()=>n.e(81922).then(n.t.bind(n,18338,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-publishing-196.json",18338],d1b15a6d:[()=>n.e(98532).then(n.bind(n,34154)),"@site/docs/minikube/building-an-image-and-testing-it-in-minikube.md",34154],d1c21237:[()=>n.e(3342).then(n.bind(n,10330)),"@site/blog/2024-04-30-release-1.10.md",10330],d46ef83d:[()=>n.e(10579).then(n.bind(n,19909)),"@site/api/type-aliases/MountPropagation.md",19909],d4840880:[()=>n.e(79106).then(n.bind(n,39282)),"@site/docs/extensions/publish/index.md",39282],d496897e:[()=>n.e(25211).then(n.bind(n,87394)),"@site/api/namespaces/containerEngine/functions/createPod.md",87394],d4bf7e47:[()=>n.e(58989).then(n.bind(n,67559)),"@site/docs/troubleshooting/troubleshooting-podman-on-macos.md",67559],d651e2ee:[()=>n.e(78514).then(n.bind(n,47e3)),"@site/docs/troubleshooting/index.md",47e3],d66cbd9e:[()=>n.e(20044).then(n.bind(n,37558)),"@site/api/interfaces/Port.md",37558],d739767a:[()=>n.e(64389).then(n.bind(n,12904)),"@site/api/namespaces/env/functions/onDidChangeTelemetryEnabled.md",12904],d7ed6ffb:[()=>n.e(59875).then(n.bind(n,32183)),"@site/docs/ai-lab/index.md",32183],d7fbbe43:[()=>n.e(92217).then(n.bind(n,10464)),"@site/src/pages/features/index.tsx",10464],d83f208d:[()=>n.e(13317).then(n.bind(n,56993)),"@site/api/interfaces/RunOptions.md",56993],d9407a00:[()=>n.e(16728).then(n.bind(n,58836)),"@site/api/namespaces/window/functions/showNotification.md",58836],d9673b17:[()=>n.e(58673).then(n.bind(n,47262)),"@site/api/interfaces/NotificationOptions.md",47262],d9b4ee1e:[()=>n.e(19841).then(n.bind(n,46693)),"@site/api/type-aliases/KubernetesGeneratorSelector.md",46693],da802cf4:[()=>n.e(96915).then(n.t.bind(n,65091,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-linux-951.json",65091],db22fd17:[()=>n.e(43474).then(n.bind(n,4088)),"@site/api/type-aliases/CliToolState.md",4088],db320b4a:[()=>n.e(19204).then(n.t.bind(n,88395,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-dockerfile-c3c.json",88395],dc23cd40:[()=>n.e(99124).then(n.bind(n,8051)),"@site/api/interfaces/PodCreateOptions.md",8051],de311ed4:[()=>n.e(71625).then(n.bind(n,79790)),"@site/blog/2023-04-19-running-a-local-kubernetes-cluster-with-podman-desktop.md",79790],dec87402:[()=>n.e(1837).then(n.bind(n,70887)),"@site/api/namespaces/containerEngine/functions/tagImage.md",70887],deccabf3:[()=>n.e(18880).then(n.bind(n,18654)),"@site/api/enumerations/InputBoxValidationSeverity.md",18654],df203c0f:[()=>Promise.all([n.e(40532),n.e(99924)]).then(n.bind(n,67051)),"@theme/DocTagDocListPage",67051],df2a6e58:[()=>n.e(37683).then(n.bind(n,39406)),"@site/api/namespaces/containerEngine/functions/listInfos.md",39406],df322e14:[()=>Promise.all([n.e(40532),n.e(80945)]).then(n.bind(n,30979)),"@site/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md",30979],df4d464e:[()=>n.e(82409).then(n.bind(n,56227)),"@site/api/namespaces/kubernetes/functions/setKubeconfig.md",56227],e0277333:[()=>n.e(52920).then(n.bind(n,74100)),"@site/api/interfaces/AuditRequestItems.md",74100],e064f6d4:[()=>n.e(2866).then(n.bind(n,52262)),"@site/api/interfaces/ContainerInspectInfo.md",52262],e1a2ab10:[()=>n.e(70225).then(n.bind(n,99919)),"@site/api/interfaces/ProviderInstallation.md",99919],e1c8d71f:[()=>n.e(34884).then(n.bind(n,16061)),"@site/api/type-aliases/NotificationType.md",16061],e35d7c3e:[()=>n.e(5697).then(n.bind(n,20266)),"@site/api/interfaces/NetworkCreateResult.md",20266],e38c422a:[()=>n.e(94331).then(n.bind(n,46413)),"@site/api/namespaces/configuration/functions/getConfiguration.md",46413],e3f28bf9:[()=>n.e(36248).then(n.bind(n,94615)),"@site/api/interfaces/RegisterKubernetesConnectionEvent.md",94615],e44de27e:[()=>n.e(92599).then(n.bind(n,37639)),"@site/docs/podman/setting-podman-machine-default-connection.md",37639],e546fc5a:[()=>n.e(63190).then(n.bind(n,7761)),"@site/api/namespaces/proxy/functions/onDidUpdateProxy.md",7761],e6163b65:[()=>n.e(92045).then(n.bind(n,9405)),"@site/api/namespaces/extensions/functions/onDidChange.md",9405],e6412603:[()=>n.e(92955).then(n.bind(n,82390)),"@site/api/namespaces/registry/functions/onDidUpdateRegistry.md",82390],e665718d:[()=>Promise.all([n.e(18565),n.e(10114)]).then(n.bind(n,31261)),"@site/src/pages/extend/index.tsx",31261],e69dadab:[()=>n.e(75273).then(n.bind(n,52818)),"@site/api/interfaces/PodmanContainerCreateOptions.md",52818],e6c31e60:[()=>n.e(72931).then(n.bind(n,98521)),"@site/api/interfaces/ProviderUpdate.md",98521],e6fb1369:[()=>n.e(58800).then(n.bind(n,58488)),"@site/blog/2023-01-18-release-0.11.md?truncated=true",58488],e73930cf:[()=>n.e(36101).then(n.t.bind(n,26948,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-migrating-to-kubernetes-758.json",26948],e7477a94:[()=>n.e(12864).then(n.bind(n,50413)),"@site/api/interfaces/InstallCheck.md",50413],e7923b27:[()=>n.e(9055).then(n.bind(n,18485)),"@site/api/interfaces/Event.md",18485],e84cabb0:[()=>n.e(81145).then(n.bind(n,473)),"@site/api/namespaces/proxy/functions/setProxy.md",473],e88443f3:[()=>n.e(97953).then(n.bind(n,54910)),"@site/api/namespaces/containerEngine/functions/stopPod.md",54910],e983a6d7:[()=>n.e(61281).then(n.bind(n,20636)),"@site/api/namespaces/env/variables/isMac.md",20636],ea3ffc82:[()=>n.e(21181).then(n.bind(n,65494)),"@site/api/interfaces/ExtensionContext.md",65494],eb17771c:[()=>n.e(67480).then(n.bind(n,71957)),"@site/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md",71957],ed1f6062:[()=>n.e(63773).then(n.bind(n,80657)),"@site/docs/extensions/developing/menu.md",80657],ed2a4846:[()=>n.e(40486).then(n.bind(n,41712)),"@site/api/interfaces/GenerateKubeResult.md",41712],ed603d23:[()=>n.e(73285).then(n.bind(n,16598)),"@site/api/interfaces/KubernetesGeneratorProvider.md",16598],ed75cfcb:[()=>n.e(3584).then(n.bind(n,80551)),"@site/docs/migrating-from-docker/using-podman-mac-helper.md",80551],edb40f78:[()=>n.e(54632).then(n.bind(n,5286)),"@site/api/interfaces/Progress.md",5286],edcfca88:[()=>n.e(41902).then(n.bind(n,1361)),"@site/api/interfaces/ManifestInspectInfo.md",1361],ef5945f7:[()=>n.e(63630).then(n.bind(n,12294)),"@site/api/interfaces/Extension.md",12294],f0e3a130:[()=>Promise.all([n.e(95628),n.e(65776)]).then(n.bind(n,11316)),"@site/blog/2023-08-16-release-1.3.md",11316],f16d562f:[()=>n.e(61110).then(n.t.bind(n,32057,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-macos-3da.json",32057],f1ad83b2:[()=>n.e(22182).then(n.bind(n,35522)),"@site/api/interfaces/KubernetesProviderConnection.md",35522],f20efc55:[()=>n.e(64438).then(n.bind(n,61688)),"@site/api/variables/StatusBarItemDefaultPriority.md",61688],f26f8f05:[()=>n.e(38780).then(n.bind(n,17177)),"@site/docs/compose/troubleshooting.md",17177],f27eaf88:[()=>n.e(75741).then(n.bind(n,13451)),"@site/api/interfaces/CancellationToken.md",13451],f4271232:[()=>n.e(85799).then(n.bind(n,96745)),"@site/api/namespaces/navigation/functions/navigateToContainerLogs.md",96745],f431c910:[()=>n.e(93690).then(n.t.bind(n,24361,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-openshift-56a.json",24361],f523fb3f:[()=>Promise.all([n.e(40532),n.e(83973)]).then(n.bind(n,8392)),"@site/docs/migrating-from-docker/using-the-docker_host-environment-variable.md",8392],f644aac7:[()=>n.e(72303).then(n.t.bind(n,6029,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-tags-api-24b.json",6029],f6cd0d3d:[()=>n.e(75208).then(n.bind(n,15805)),"@site/api/interfaces/RegistryProvider.md",15805],f6cf66bc:[()=>n.e(65619).then(n.bind(n,44835)),"@site/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig.md",44835],f7197f43:[()=>n.e(56805).then(n.bind(n,3574)),"@site/api/classes/TelemetryTrustedValue.md",3574],f771dec1:[()=>n.e(63863).then(n.bind(n,62842)),"@site/api/namespaces/cli/functions/createCliTool.md",62842],f7c9e078:[()=>n.e(21364).then(n.bind(n,80487)),"@site/api/interfaces/ThrottlingData.md",80487],f81c1134:[()=>n.e(44031).then(n.t.bind(n,4108,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-archive-f05.json",4108],f86eb50f:[()=>n.e(48123).then(n.bind(n,5087)),"@site/api/interfaces/ContainerProviderConnectionFactory.md",5087],f9fb4395:[()=>n.e(84573).then(n.bind(n,13547)),"@site/blog/2023-12-06-sharing-podman-images-with-kubernetes-cluster.md",13547],fa5f999e:[()=>n.e(93300).then(n.t.bind(n,3697,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-migrating-62e.json",3697],fb50ea3a:[()=>n.e(82451).then(n.bind(n,54884)),"@site/docs/kind/building-an-image-and-testing-it-in-kind.md",54884],fb8cd692:[()=>n.e(80511).then(n.bind(n,10252)),"@site/api/interfaces/HostConfig.md",10252],fbfd390f:[()=>n.e(95921).then(n.bind(n,27916)),"@site/api/interfaces/AuditResult.md",27916],fc8a94e3:[()=>n.e(61425).then(n.bind(n,70607)),"@site/docs/openshift/developer-sandbox/index.md",70607],fc923f19:[()=>n.e(73177).then(n.bind(n,96868)),"@site/api/interfaces/ImageCheck.md",96868],fd684bd6:[()=>Promise.all([n.e(40532),n.e(4117)]).then(n.bind(n,81775)),"@site/docs/containers/registries/index.md",81775],fd702dc7:[()=>n.e(57694).then(n.bind(n,71523)),"@site/api/interfaces/WebviewOptions.md",71523],fe0d4a0f:[()=>n.e(51978).then(n.bind(n,65030)),"@site/api/namespaces/tray/index.md",65030],fe1a05e2:[()=>n.e(70900).then(n.bind(n,64243)),"@site/api/namespaces/tray/functions/registerProviderMenuItem.md",64243],fe716911:[()=>n.e(33940).then(n.bind(n,71774)),"@site/api/interfaces/CheckResult.md",71774],fe9a92c0:[()=>n.e(71781).then(n.t.bind(n,11411,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-onboarding-03e.json",11411],fee0a0be:[()=>n.e(81580).then(n.bind(n,76926)),"@site/api/interfaces/ContainerEngineInfo.md",76926],ff2f63f6:[()=>n.e(68097).then(n.bind(n,832)),"@site/api/interfaces/SecretStorageChangeEvent.md",832],ff38b1ce:[()=>n.e(87759).then(n.bind(n,99766)),"@site/blog/2023-09-18-release-1.4.md",99766],fff8aeb8:[()=>n.e(84413).then(n.bind(n,63978)),"@site/blog/2024-03-07-release-1.8.md",63978]};var s=n(24246);function c(e){let{error:t,retry:n,pastDelay:a}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):a?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var l=n(13361),d=n(66881);function u(e,t){if("*"===e)return i()({loading:c,loader:()=>n.e(14094).then(n.bind(n,14094)),modules:["@theme/NotFound"],webpack:()=>[14094],render(e,t){const n=e.default;return(0,s.jsx)(d.z,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const a=o[`${e}-${t}`],u={},p=[],f=[],m=(0,l.Z)(a);return Object.entries(m).forEach((e=>{let[t,n]=e;const a=r[n];a&&(u[t]=a[0],p.push(a[1]),f.push(a[2]))})),i().Map({loading:c,loader:u,modules:p,webpack:()=>f,render(t,n){const i=JSON.parse(JSON.stringify(a));Object.entries(t).forEach((t=>{let[n,a]=t;const o=a.default;if(!o)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof o&&"function"!=typeof o||Object.keys(a).filter((e=>"default"!==e)).forEach((e=>{o[e]=a[e]}));let r=i;const s=n.split(".");s.slice(0,-1).forEach((e=>{r=r[e]})),r[s[s.length-1]]=o}));const o=i.__comp;delete i.__comp;const r=i.__context;delete i.__context;const c=i.__props;return delete i.__props,(0,s.jsx)(d.z,{value:r,children:(0,s.jsx)(o,{...i,...c,...n})})}})}const p=[{path:"/blog",component:u("/blog","97e"),exact:!0},{path:"/blog/5-things-to-know-for-a-docker-user",component:u("/blog/5-things-to-know-for-a-docker-user","253"),exact:!0},{path:"/blog/archive",component:u("/blog/archive","182"),exact:!0},{path:"/blog/develop-using-devcontainer",component:u("/blog/develop-using-devcontainer","41f"),exact:!0},{path:"/blog/getting-started-with-compose",component:u("/blog/getting-started-with-compose","4a8"),exact:!0},{path:"/blog/podman-desktop-release-0.10",component:u("/blog/podman-desktop-release-0.10","7ba"),exact:!0},{path:"/blog/podman-desktop-release-0.11",component:u("/blog/podman-desktop-release-0.11","ca4"),exact:!0},{path:"/blog/podman-desktop-release-0.12",component:u("/blog/podman-desktop-release-0.12","d23"),exact:!0},{path:"/blog/podman-desktop-release-0.13",component:u("/blog/podman-desktop-release-0.13","d2e"),exact:!0},{path:"/blog/podman-desktop-release-0.14",component:u("/blog/podman-desktop-release-0.14","1fe"),exact:!0},{path:"/blog/podman-desktop-release-0.15",component:u("/blog/podman-desktop-release-0.15","036"),exact:!0},{path:"/blog/podman-desktop-release-1.0",component:u("/blog/podman-desktop-release-1.0","d27"),exact:!0},{path:"/blog/podman-desktop-release-1.1",component:u("/blog/podman-desktop-release-1.1","669"),exact:!0},{path:"/blog/podman-desktop-release-1.10",component:u("/blog/podman-desktop-release-1.10","be8"),exact:!0},{path:"/blog/podman-desktop-release-1.2",component:u("/blog/podman-desktop-release-1.2","15f"),exact:!0},{path:"/blog/podman-desktop-release-1.3",component:u("/blog/podman-desktop-release-1.3","1b7"),exact:!0},{path:"/blog/podman-desktop-release-1.4",component:u("/blog/podman-desktop-release-1.4","19c"),exact:!0},{path:"/blog/podman-desktop-release-1.5",component:u("/blog/podman-desktop-release-1.5","2d4"),exact:!0},{path:"/blog/podman-desktop-release-1.6",component:u("/blog/podman-desktop-release-1.6","f43"),exact:!0},{path:"/blog/podman-desktop-release-1.7",component:u("/blog/podman-desktop-release-1.7","d3f"),exact:!0},{path:"/blog/podman-desktop-release-1.8",component:u("/blog/podman-desktop-release-1.8","cfd"),exact:!0},{path:"/blog/podman-desktop-release-1.9",component:u("/blog/podman-desktop-release-1.9","1b1"),exact:!0},{path:"/blog/podman-desktop-wins-devies-award",component:u("/blog/podman-desktop-wins-devies-award","c3f"),exact:!0},{path:"/blog/running-a-local-kubernetes-cluster-with-podman-desktop",component:u("/blog/running-a-local-kubernetes-cluster-with-podman-desktop","6b3"),exact:!0},{path:"/blog/sharing-podman-images-with-kubernetes-cluster",component:u("/blog/sharing-podman-images-with-kubernetes-cluster","18f"),exact:!0},{path:"/blog/tags",component:u("/blog/tags","287"),exact:!0},{path:"/blog/tags/award",component:u("/blog/tags/award","0a5"),exact:!0},{path:"/blog/tags/codespaces",component:u("/blog/tags/codespaces","407"),exact:!0},{path:"/blog/tags/compose",component:u("/blog/tags/compose","e8b"),exact:!0},{path:"/blog/tags/containerfile",component:u("/blog/tags/containerfile","bba"),exact:!0},{path:"/blog/tags/containers",component:u("/blog/tags/containers","b86"),exact:!0},{path:"/blog/tags/devcontainer",component:u("/blog/tags/devcontainer","110"),exact:!0},{path:"/blog/tags/docker",component:u("/blog/tags/docker","cee"),exact:!0},{path:"/blog/tags/docker-compose",component:u("/blog/tags/docker-compose","1e9"),exact:!0},{path:"/blog/tags/dockerfile",component:u("/blog/tags/dockerfile","e6e"),exact:!0},{path:"/blog/tags/extensions",component:u("/blog/tags/extensions","837"),exact:!0},{path:"/blog/tags/images",component:u("/blog/tags/images","841"),exact:!0},{path:"/blog/tags/kind",component:u("/blog/tags/kind","a29"),exact:!0},{path:"/blog/tags/kubernetes",component:u("/blog/tags/kubernetes","d31"),exact:!0},{path:"/blog/tags/migrating",component:u("/blog/tags/migrating","bd8"),exact:!0},{path:"/blog/tags/multi-container",component:u("/blog/tags/multi-container","2ef"),exact:!0},{path:"/blog/tags/onboarding",component:u("/blog/tags/onboarding","766"),exact:!0},{path:"/blog/tags/openshift",component:u("/blog/tags/openshift","13f"),exact:!0},{path:"/blog/tags/podman",component:u("/blog/tags/podman","135"),exact:!0},{path:"/blog/tags/podman-desktop",component:u("/blog/tags/podman-desktop","1ba"),exact:!0},{path:"/blog/tags/release",component:u("/blog/tags/release","dfe"),exact:!0},{path:"/blog/tags/settings",component:u("/blog/tags/settings","164"),exact:!0},{path:"/blog/tags/story",component:u("/blog/tags/story","002"),exact:!0},{path:"/blog/tags/wasi",component:u("/blog/tags/wasi","a30"),exact:!0},{path:"/blog/tags/wasm",component:u("/blog/tags/wasm","ac1"),exact:!0},{path:"/blog/tags/web-assembly",component:u("/blog/tags/web-assembly","e12"),exact:!0},{path:"/blog/wasm-workloads-on-macos-and-windows-with-podman",component:u("/blog/wasm-workloads-on-macos-and-windows-with-podman","621"),exact:!0},{path:"/core-values",component:u("/core-values","66d"),exact:!0},{path:"/downloads",component:u("/downloads","3ae"),exact:!0},{path:"/downloads/linux",component:u("/downloads/linux","129"),exact:!0},{path:"/downloads/macos",component:u("/downloads/macos","b7b"),exact:!0},{path:"/downloads/windows",component:u("/downloads/windows","90e"),exact:!0},{path:"/extend",component:u("/extend","037"),exact:!0},{path:"/extensions/ai-lab",component:u("/extensions/ai-lab","f90"),exact:!0},{path:"/features",component:u("/features","b47"),exact:!0},{path:"/search",component:u("/search","5de"),exact:!0},{path:"/api",component:u("/api","4ea"),routes:[{path:"/api",component:u("/api","b83"),routes:[{path:"/api",component:u("/api","e29"),routes:[{path:"/api",component:u("/api","a0b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/classes/CancellationTokenSource",component:u("/api/classes/CancellationTokenSource","0f1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/classes/Disposable",component:u("/api/classes/Disposable","ff9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/classes/EventEmitter",component:u("/api/classes/EventEmitter","f24"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/classes/TelemetryTrustedValue",component:u("/api/classes/TelemetryTrustedValue","223"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/classes/Uri",component:u("/api/classes/Uri","896"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/enumerations/InputBoxValidationSeverity",component:u("/api/enumerations/InputBoxValidationSeverity","9c8"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/enumerations/ProgressLocation",component:u("/api/enumerations/ProgressLocation","397"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/enumerations/QuickPickItemKind",component:u("/api/enumerations/QuickPickItemKind","be0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Auditor",component:u("/api/interfaces/Auditor","bf2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuditRecord",component:u("/api/interfaces/AuditRecord","c78"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuditRequestItems",component:u("/api/interfaces/AuditRequestItems","da2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuditResult",component:u("/api/interfaces/AuditResult","d04"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthConfig",component:u("/api/interfaces/AuthConfig","979"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationGetSessionOptions",component:u("/api/interfaces/AuthenticationGetSessionOptions","ca1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationProvider",component:u("/api/interfaces/AuthenticationProvider","b9e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent",component:u("/api/interfaces/AuthenticationProviderAuthenticationSessionsChangeEvent","10c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationProviderInformation",component:u("/api/interfaces/AuthenticationProviderInformation","17b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationProviderOptions",component:u("/api/interfaces/AuthenticationProviderOptions","352"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationSession",component:u("/api/interfaces/AuthenticationSession","a3d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationSessionAccountInformation",component:u("/api/interfaces/AuthenticationSessionAccountInformation","f08"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/AuthenticationSessionsChangeEvent",component:u("/api/interfaces/AuthenticationSessionsChangeEvent","df7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/BlkioStatEntry",component:u("/api/interfaces/BlkioStatEntry","86d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/BlkioStats",component:u("/api/interfaces/BlkioStats","47d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/BuildImageOptions",component:u("/api/interfaces/BuildImageOptions","de6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CancellationToken",component:u("/api/interfaces/CancellationToken","294"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CheckResult",component:u("/api/interfaces/CheckResult","e6e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CheckResultFixCommand",component:u("/api/interfaces/CheckResultFixCommand","b94"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Clipboard",component:u("/api/interfaces/Clipboard","80a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CliTool",component:u("/api/interfaces/CliTool","3ad"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CliToolOptions",component:u("/api/interfaces/CliToolOptions","46a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CliToolUpdate",component:u("/api/interfaces/CliToolUpdate","e3e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CliToolUpdateOptions",component:u("/api/interfaces/CliToolUpdateOptions","8a2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Command",component:u("/api/interfaces/Command","626"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Configuration",component:u("/api/interfaces/Configuration","7a0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ConfigurationChangeEvent",component:u("/api/interfaces/ConfigurationChangeEvent","e02"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerAuthInfo",component:u("/api/interfaces/ContainerAuthInfo","e07"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerCreateOptions",component:u("/api/interfaces/ContainerCreateOptions","eeb"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerCreateResult",component:u("/api/interfaces/ContainerCreateResult","92f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerEngineInfo",component:u("/api/interfaces/ContainerEngineInfo","89e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerInfo",component:u("/api/interfaces/ContainerInfo","25c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerInspectInfo",component:u("/api/interfaces/ContainerInspectInfo","5e2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerJSONEvent",component:u("/api/interfaces/ContainerJSONEvent","b56"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerProviderConnection",component:u("/api/interfaces/ContainerProviderConnection","724"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerProviderConnectionEndpoint",component:u("/api/interfaces/ContainerProviderConnectionEndpoint","1b5"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerProviderConnectionFactory",component:u("/api/interfaces/ContainerProviderConnectionFactory","019"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ContainerStatsInfo",component:u("/api/interfaces/ContainerStatsInfo","da8"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CPUStats",component:u("/api/interfaces/CPUStats","b61"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CPUUsage",component:u("/api/interfaces/CPUUsage","73a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CustomPick",component:u("/api/interfaces/CustomPick","753"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CustomPickItem",component:u("/api/interfaces/CustomPickItem","d96"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/CustomPickSectionItem",component:u("/api/interfaces/CustomPickSectionItem","5f0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/DeviceRequest",component:u("/api/interfaces/DeviceRequest","50b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/EndpointIPAMConfig",component:u("/api/interfaces/EndpointIPAMConfig","d82"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/EndpointSettings",component:u("/api/interfaces/EndpointSettings","0ec"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Event",component:u("/api/interfaces/Event","5ca"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Extension",component:u("/api/interfaces/Extension","84a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ExtensionContext",component:u("/api/interfaces/ExtensionContext","2ea"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/FileSystemWatcher",component:u("/api/interfaces/FileSystemWatcher","837"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/GenerateKubeResult",component:u("/api/interfaces/GenerateKubeResult","8f5"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/HealthCheckLog",component:u("/api/interfaces/HealthCheckLog","348"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/HealthCheckResults",component:u("/api/interfaces/HealthCheckResults","653"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/HealthConfig",component:u("/api/interfaces/HealthConfig","ac3"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/HostConfig",component:u("/api/interfaces/HostConfig","011"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/HostRestartPolicy",component:u("/api/interfaces/HostRestartPolicy","ead"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageCheck",component:u("/api/interfaces/ImageCheck","ec7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageCheckerProvider",component:u("/api/interfaces/ImageCheckerProvider","c2e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageCheckerProviderMetadata",component:u("/api/interfaces/ImageCheckerProviderMetadata","d33"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageChecks",component:u("/api/interfaces/ImageChecks","b28"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageInfo",component:u("/api/interfaces/ImageInfo","111"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ImageInspectInfo",component:u("/api/interfaces/ImageInspectInfo","436"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/InputBoxOptions",component:u("/api/interfaces/InputBoxOptions","26e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/InputBoxValidationMessage",component:u("/api/interfaces/InputBoxValidationMessage","eb7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/InstallCheck",component:u("/api/interfaces/InstallCheck","683"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/IPAM",component:u("/api/interfaces/IPAM","b8b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/KubeconfigUpdateEvent",component:u("/api/interfaces/KubeconfigUpdateEvent","e34"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/KubernetesGeneratorProvider",component:u("/api/interfaces/KubernetesGeneratorProvider","c21"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/KubernetesProviderConnection",component:u("/api/interfaces/KubernetesProviderConnection","cd1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/KubernetesProviderConnectionEndpoint",component:u("/api/interfaces/KubernetesProviderConnectionEndpoint","565"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/KubernetesProviderConnectionFactory",component:u("/api/interfaces/KubernetesProviderConnectionFactory","fa7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/LifecycleContext",component:u("/api/interfaces/LifecycleContext","615"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Link",component:u("/api/interfaces/Link","75e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ListImagesOptions",component:u("/api/interfaces/ListImagesOptions","412"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ListInfosOptions",component:u("/api/interfaces/ListInfosOptions","68f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Logger",component:u("/api/interfaces/Logger","0b0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ManifestCreateOptions",component:u("/api/interfaces/ManifestCreateOptions","120"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ManifestInspectInfo",component:u("/api/interfaces/ManifestInspectInfo","e98"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/MemoryStats",component:u("/api/interfaces/MemoryStats","995"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/MenuItem",component:u("/api/interfaces/MenuItem","88f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/MountSettings",component:u("/api/interfaces/MountSettings","18e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkContainer",component:u("/api/interfaces/NetworkContainer","11a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkCreateOptions",component:u("/api/interfaces/NetworkCreateOptions","373"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkCreateResult",component:u("/api/interfaces/NetworkCreateResult","97d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkInfo",component:u("/api/interfaces/NetworkInfo","b9e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkingConfig",component:u("/api/interfaces/NetworkingConfig","64a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkInspectInfo",component:u("/api/interfaces/NetworkInspectInfo","77b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NetworkStats",component:u("/api/interfaces/NetworkStats","264"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/NotificationOptions",component:u("/api/interfaces/NotificationOptions","25f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/OpenDialogOptions",component:u("/api/interfaces/OpenDialogOptions","fe2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PidsStats",component:u("/api/interfaces/PidsStats","30a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PodContainerInfo",component:u("/api/interfaces/PodContainerInfo","0d9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PodCreateOptions",component:u("/api/interfaces/PodCreateOptions","83b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PodCreatePortOptions",component:u("/api/interfaces/PodCreatePortOptions","52b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PodInfo",component:u("/api/interfaces/PodInfo","de0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PodmanContainerCreateOptions",component:u("/api/interfaces/PodmanContainerCreateOptions","dbe"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Port",component:u("/api/interfaces/Port","6d8"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PortBinding",component:u("/api/interfaces/PortBinding","eed"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PortMap",component:u("/api/interfaces/PortMap","628"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Progress",component:u("/api/interfaces/Progress","0bb"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProgressOptions",component:u("/api/interfaces/ProgressOptions","acf"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Provider",component:u("/api/interfaces/Provider","c22"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderAutostart",component:u("/api/interfaces/ProviderAutostart","f65"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderCleanup",component:u("/api/interfaces/ProviderCleanup","30e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderCleanupAction",component:u("/api/interfaces/ProviderCleanupAction","a5f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderCleanupExecuteOptions",component:u("/api/interfaces/ProviderCleanupExecuteOptions","c14"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderConnectionFactory",component:u("/api/interfaces/ProviderConnectionFactory","a5a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderConnectionLifecycle",component:u("/api/interfaces/ProviderConnectionLifecycle","f3c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderContainerConnection",component:u("/api/interfaces/ProviderContainerConnection","85f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderDetectionCheck",component:u("/api/interfaces/ProviderDetectionCheck","672"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderEvent",component:u("/api/interfaces/ProviderEvent","01b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderImages",component:u("/api/interfaces/ProviderImages","c63"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderInformation",component:u("/api/interfaces/ProviderInformation","b0d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderInstallation",component:u("/api/interfaces/ProviderInstallation","315"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderLifecycle",component:u("/api/interfaces/ProviderLifecycle","efd"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderOptions",component:u("/api/interfaces/ProviderOptions","a07"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProviderUpdate",component:u("/api/interfaces/ProviderUpdate","269"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ProxySettings",component:u("/api/interfaces/ProxySettings","4ff"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/PullEvent",component:u("/api/interfaces/PullEvent","70a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/QuickInputButton",component:u("/api/interfaces/QuickInputButton","5ca"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/QuickPickItem",component:u("/api/interfaces/QuickPickItem","9f0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/QuickPickOptions",component:u("/api/interfaces/QuickPickOptions","a9b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegisterContainerConnectionEvent",component:u("/api/interfaces/RegisterContainerConnectionEvent","db4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegisterKubernetesConnectionEvent",component:u("/api/interfaces/RegisterKubernetesConnectionEvent","6c6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Registry",component:u("/api/interfaces/Registry","6aa"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegistryConfig",component:u("/api/interfaces/RegistryConfig","d1f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegistryCreateOptions",component:u("/api/interfaces/RegistryCreateOptions","74a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegistryProvider",component:u("/api/interfaces/RegistryProvider","b3a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RegistrySuggestedProvider",component:u("/api/interfaces/RegistrySuggestedProvider","fc0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RunError",component:u("/api/interfaces/RunError","d2a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RunOptions",component:u("/api/interfaces/RunOptions","d3a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/RunResult",component:u("/api/interfaces/RunResult","b9b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/SaveDialogOptions",component:u("/api/interfaces/SaveDialogOptions","26b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/SecretStorage",component:u("/api/interfaces/SecretStorage","6aa"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/SecretStorageChangeEvent",component:u("/api/interfaces/SecretStorageChangeEvent","333"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/StatusBarItem",component:u("/api/interfaces/StatusBarItem","d57"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/StorageStats",component:u("/api/interfaces/StorageStats","19d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/TelemetryLogger",component:u("/api/interfaces/TelemetryLogger","281"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/TelemetryLoggerOptions",component:u("/api/interfaces/TelemetryLoggerOptions","020"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/TelemetrySender",component:u("/api/interfaces/TelemetrySender","f31"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/ThrottlingData",component:u("/api/interfaces/ThrottlingData","a4f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/UnregisterContainerConnectionEvent",component:u("/api/interfaces/UnregisterContainerConnectionEvent","1a4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/UnregisterKubernetesConnectionEvent",component:u("/api/interfaces/UnregisterKubernetesConnectionEvent","020"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/UpdateContainerConnectionEvent",component:u("/api/interfaces/UpdateContainerConnectionEvent","37a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/UpdateKubernetesConnectionEvent",component:u("/api/interfaces/UpdateKubernetesConnectionEvent","b47"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/VolumeCreateOptions",component:u("/api/interfaces/VolumeCreateOptions","3c9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/VolumeCreateResponseInfo",component:u("/api/interfaces/VolumeCreateResponseInfo","d5b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/VolumeDeleteOptions",component:u("/api/interfaces/VolumeDeleteOptions","e8c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/VolumeInfo",component:u("/api/interfaces/VolumeInfo","d96"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/VolumeListInfo",component:u("/api/interfaces/VolumeListInfo","fab"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/Webview",component:u("/api/interfaces/Webview","e95"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/WebviewInfo",component:u("/api/interfaces/WebviewInfo","8e0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/WebviewOptions",component:u("/api/interfaces/WebviewOptions","42b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/WebviewPanel",component:u("/api/interfaces/WebviewPanel","6e6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/interfaces/WebviewPanelOnDidChangeViewStateEvent",component:u("/api/interfaces/WebviewPanelOnDidChangeViewStateEvent","fa8"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/authentication",component:u("/api/namespaces/authentication","568"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/authentication/functions/getSession",component:u("/api/namespaces/authentication/functions/getSession","80c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/authentication/functions/onDidChangeSessions",component:u("/api/namespaces/authentication/functions/onDidChangeSessions","d5b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/authentication/functions/registerAuthenticationProvider",component:u("/api/namespaces/authentication/functions/registerAuthenticationProvider","15b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/cli",component:u("/api/namespaces/cli","ffd"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/cli/functions/createCliTool",component:u("/api/namespaces/cli/functions/createCliTool","1e7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/commands",component:u("/api/namespaces/commands","f15"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/commands/functions/executeCommand",component:u("/api/namespaces/commands/functions/executeCommand","544"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/commands/functions/registerCommand",component:u("/api/namespaces/commands/functions/registerCommand","e5f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/configuration",component:u("/api/namespaces/configuration","e02"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/configuration/functions/getConfiguration",component:u("/api/namespaces/configuration/functions/getConfiguration","8f6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/configuration/functions/onDidChangeConfiguration",component:u("/api/namespaces/configuration/functions/onDidChangeConfiguration","08c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine",component:u("/api/namespaces/containerEngine","cd2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/buildImage",component:u("/api/namespaces/containerEngine/functions/buildImage","d57"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/createContainer",component:u("/api/namespaces/containerEngine/functions/createContainer","ba1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/createManifest",component:u("/api/namespaces/containerEngine/functions/createManifest","44c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/createNetwork",component:u("/api/namespaces/containerEngine/functions/createNetwork","66e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/createPod",component:u("/api/namespaces/containerEngine/functions/createPod","b21"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/createVolume",component:u("/api/namespaces/containerEngine/functions/createVolume","3af"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/deleteContainer",component:u("/api/namespaces/containerEngine/functions/deleteContainer","eb7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/deleteImage",component:u("/api/namespaces/containerEngine/functions/deleteImage","af6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/deleteVolume",component:u("/api/namespaces/containerEngine/functions/deleteVolume","e7d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/getImageInspect",component:u("/api/namespaces/containerEngine/functions/getImageInspect","0bb"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/info",component:u("/api/namespaces/containerEngine/functions/info","ae4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/inspectContainer",component:u("/api/namespaces/containerEngine/functions/inspectContainer","0a0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/inspectManifest",component:u("/api/namespaces/containerEngine/functions/inspectManifest","a0c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listContainers",component:u("/api/namespaces/containerEngine/functions/listContainers","74b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listImages",component:u("/api/namespaces/containerEngine/functions/listImages","849"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listInfos",component:u("/api/namespaces/containerEngine/functions/listInfos","b43"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listNetworks",component:u("/api/namespaces/containerEngine/functions/listNetworks","d8a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listPods",component:u("/api/namespaces/containerEngine/functions/listPods","9dd"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/listVolumes",component:u("/api/namespaces/containerEngine/functions/listVolumes","01a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/logsContainer",component:u("/api/namespaces/containerEngine/functions/logsContainer","f39"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/onEvent",component:u("/api/namespaces/containerEngine/functions/onEvent","11e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/pullImage",component:u("/api/namespaces/containerEngine/functions/pullImage","7a9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/pushImage",component:u("/api/namespaces/containerEngine/functions/pushImage","fbf"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/removePod",component:u("/api/namespaces/containerEngine/functions/removePod","953"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/replicatePodmanContainer",component:u("/api/namespaces/containerEngine/functions/replicatePodmanContainer","ed1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/saveImage",component:u("/api/namespaces/containerEngine/functions/saveImage","9f1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/startContainer",component:u("/api/namespaces/containerEngine/functions/startContainer","863"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/startPod",component:u("/api/namespaces/containerEngine/functions/startPod","7b6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/statsContainer",component:u("/api/namespaces/containerEngine/functions/statsContainer","92f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/stopContainer",component:u("/api/namespaces/containerEngine/functions/stopContainer","a55"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/stopPod",component:u("/api/namespaces/containerEngine/functions/stopPod","408"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/containerEngine/functions/tagImage",component:u("/api/namespaces/containerEngine/functions/tagImage","179"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/context",component:u("/api/namespaces/context","78b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/context/functions/setValue",component:u("/api/namespaces/context/functions/setValue","ef4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env",component:u("/api/namespaces/env","d0c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/functions/createTelemetryLogger",component:u("/api/namespaces/env/functions/createTelemetryLogger","c90"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/functions/onDidChangeTelemetryEnabled",component:u("/api/namespaces/env/functions/onDidChangeTelemetryEnabled","41f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/functions/openExternal",component:u("/api/namespaces/env/functions/openExternal","af2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/variables/clipboard",component:u("/api/namespaces/env/variables/clipboard","b93"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/variables/isLinux",component:u("/api/namespaces/env/variables/isLinux","cfc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/variables/isMac",component:u("/api/namespaces/env/variables/isMac","6fc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/variables/isTelemetryEnabled",component:u("/api/namespaces/env/variables/isTelemetryEnabled","64f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/env/variables/isWindows",component:u("/api/namespaces/env/variables/isWindows","b44"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/extensions",component:u("/api/namespaces/extensions","5be"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/extensions/functions/getExtension",component:u("/api/namespaces/extensions/functions/getExtension","46a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/extensions/functions/onDidChange",component:u("/api/namespaces/extensions/functions/onDidChange","15d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/extensions/variables/all",component:u("/api/namespaces/extensions/variables/all","63e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/fs",component:u("/api/namespaces/fs","7b7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/fs/functions/createFileSystemWatcher",component:u("/api/namespaces/fs/functions/createFileSystemWatcher","167"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/imageChecker",component:u("/api/namespaces/imageChecker","b56"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/imageChecker/functions/registerImageCheckerProvider",component:u("/api/namespaces/imageChecker/functions/registerImageCheckerProvider","659"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes",component:u("/api/namespaces/kubernetes","bbd"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes/functions/createResources",component:u("/api/namespaces/kubernetes/functions/createResources","bf0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes/functions/getKubeconfig",component:u("/api/namespaces/kubernetes/functions/getKubeconfig","91e"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig",component:u("/api/namespaces/kubernetes/functions/onDidUpdateKubeconfig","31b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes/functions/registerKubernetesGenerator",component:u("/api/namespaces/kubernetes/functions/registerKubernetesGenerator","431"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/kubernetes/functions/setKubeconfig",component:u("/api/namespaces/kubernetes/functions/setKubeconfig","c2c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation",component:u("/api/namespaces/navigation","600"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToAuthentication",component:u("/api/namespaces/navigation/functions/navigateToAuthentication","d86"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContainer",component:u("/api/namespaces/navigation/functions/navigateToContainer","e30"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContainerInspect",component:u("/api/namespaces/navigation/functions/navigateToContainerInspect","8b1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContainerLogs",component:u("/api/namespaces/navigation/functions/navigateToContainerLogs","439"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContainers",component:u("/api/namespaces/navigation/functions/navigateToContainers","635"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContainerTerminal",component:u("/api/namespaces/navigation/functions/navigateToContainerTerminal","faa"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToContribution",component:u("/api/namespaces/navigation/functions/navigateToContribution","bee"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection",component:u("/api/namespaces/navigation/functions/navigateToEditProviderContainerConnection","df4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToImage",component:u("/api/namespaces/navigation/functions/navigateToImage","5b5"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToImages",component:u("/api/namespaces/navigation/functions/navigateToImages","1bc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToPod",component:u("/api/namespaces/navigation/functions/navigateToPod","8e1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToPods",component:u("/api/namespaces/navigation/functions/navigateToPods","007"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToResources",component:u("/api/namespaces/navigation/functions/navigateToResources","2e9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToVolume",component:u("/api/namespaces/navigation/functions/navigateToVolume","859"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToVolumes",component:u("/api/namespaces/navigation/functions/navigateToVolumes","081"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/navigation/functions/navigateToWebview",component:u("/api/namespaces/navigation/functions/navigateToWebview","6b4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/process",component:u("/api/namespaces/process","9f0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/process/functions/exec",component:u("/api/namespaces/process/functions/exec","2d0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider",component:u("/api/namespaces/provider","f46"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/createProvider",component:u("/api/namespaces/provider/functions/createProvider","72f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/getContainerConnections",component:u("/api/namespaces/provider/functions/getContainerConnections","308"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/getProviderLifecycleContext",component:u("/api/namespaces/provider/functions/getProviderLifecycleContext","ee1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/onDidRegisterContainerConnection",component:u("/api/namespaces/provider/functions/onDidRegisterContainerConnection","57f"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/onDidUnregisterContainerConnection",component:u("/api/namespaces/provider/functions/onDidUnregisterContainerConnection","f4a"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/onDidUpdateContainerConnection",component:u("/api/namespaces/provider/functions/onDidUpdateContainerConnection","286"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/onDidUpdateKubernetesConnection",component:u("/api/namespaces/provider/functions/onDidUpdateKubernetesConnection","27c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/provider/functions/onDidUpdateProvider",component:u("/api/namespaces/provider/functions/onDidUpdateProvider","8dc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy",component:u("/api/namespaces/proxy","b01"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy/functions/getProxySettings",component:u("/api/namespaces/proxy/functions/getProxySettings","45d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy/functions/isEnabled",component:u("/api/namespaces/proxy/functions/isEnabled","cda"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy/functions/onDidStateChange",component:u("/api/namespaces/proxy/functions/onDidStateChange","60d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy/functions/onDidUpdateProxy",component:u("/api/namespaces/proxy/functions/onDidUpdateProxy","c0b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/proxy/functions/setProxy",component:u("/api/namespaces/proxy/functions/setProxy","2aa"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry",component:u("/api/namespaces/registry","48c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/onDidRegisterRegistry",component:u("/api/namespaces/registry/functions/onDidRegisterRegistry","ae7"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/onDidUnregisterRegistry",component:u("/api/namespaces/registry/functions/onDidUnregisterRegistry","72d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/onDidUpdateRegistry",component:u("/api/namespaces/registry/functions/onDidUpdateRegistry","0b4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/registerRegistry",component:u("/api/namespaces/registry/functions/registerRegistry","034"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/registerRegistryProvider",component:u("/api/namespaces/registry/functions/registerRegistryProvider","cd2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/suggestRegistry",component:u("/api/namespaces/registry/functions/suggestRegistry","ec2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/registry/functions/unregisterRegistry",component:u("/api/namespaces/registry/functions/unregisterRegistry","157"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/tray",component:u("/api/namespaces/tray","7da"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/tray/functions/registerMenuItem",component:u("/api/namespaces/tray/functions/registerMenuItem","194"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/tray/functions/registerProviderMenuItem",component:u("/api/namespaces/tray/functions/registerProviderMenuItem","7c8"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window",component:u("/api/namespaces/window","ebe"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/createCustomPick",component:u("/api/namespaces/window/functions/createCustomPick","8e3"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/createStatusBarItem",component:u("/api/namespaces/window/functions/createStatusBarItem","5b4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/createWebviewPanel",component:u("/api/namespaces/window/functions/createWebviewPanel","eec"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/listWebviews",component:u("/api/namespaces/window/functions/listWebviews","9b2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showErrorMessage",component:u("/api/namespaces/window/functions/showErrorMessage","a97"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showInformationMessage",component:u("/api/namespaces/window/functions/showInformationMessage","a3b"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showInputBox",component:u("/api/namespaces/window/functions/showInputBox","1e1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showNotification",component:u("/api/namespaces/window/functions/showNotification","8dc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showOpenDialog",component:u("/api/namespaces/window/functions/showOpenDialog","48d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showQuickPick",component:u("/api/namespaces/window/functions/showQuickPick","ba0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showSaveDialog",component:u("/api/namespaces/window/functions/showSaveDialog","677"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/showWarningMessage",component:u("/api/namespaces/window/functions/showWarningMessage","5e0"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/namespaces/window/functions/withProgress",component:u("/api/namespaces/window/functions/withProgress","19d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/CheckResultLink",component:u("/api/type-aliases/CheckResultLink","955"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/CliToolState",component:u("/api/type-aliases/CliToolState","3d2"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/ConfigurationScope",component:u("/api/type-aliases/ConfigurationScope","ed6"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/KubernetesGeneratorArgument",component:u("/api/type-aliases/KubernetesGeneratorArgument","c0d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/KubernetesGeneratorSelector",component:u("/api/type-aliases/KubernetesGeneratorSelector","a83"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/KubernetesGeneratorType",component:u("/api/type-aliases/KubernetesGeneratorType","73d"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/MountConfig",component:u("/api/type-aliases/MountConfig","14c"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/MountConsistency",component:u("/api/type-aliases/MountConsistency","cfc"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/MountPropagation",component:u("/api/type-aliases/MountPropagation","d25"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/MountType",component:u("/api/type-aliases/MountType","4c3"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/NotificationType",component:u("/api/type-aliases/NotificationType","e18"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/ProviderConnectionStatus",component:u("/api/type-aliases/ProviderConnectionStatus","1b9"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/ProviderLinks",component:u("/api/type-aliases/ProviderLinks","cf1"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/ProviderResult",component:u("/api/type-aliases/ProviderResult","110"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/ProviderStatus",component:u("/api/type-aliases/ProviderStatus","b46"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/type-aliases/StatusBarAlignment",component:u("/api/type-aliases/StatusBarAlignment","842"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/variables/StatusBarAlignLeft",component:u("/api/variables/StatusBarAlignLeft","7e3"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/variables/StatusBarAlignRight",component:u("/api/variables/StatusBarAlignRight","2e4"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/variables/StatusBarItemDefaultPriority",component:u("/api/variables/StatusBarItemDefaultPriority","262"),exact:!0,sidebar:"typedocSidebar"},{path:"/api/variables/version",component:u("/api/variables/version","c4f"),exact:!0,sidebar:"typedocSidebar"}]}]}]},{path:"/docs",component:u("/docs","842"),routes:[{path:"/docs",component:u("/docs","a55"),routes:[{path:"/docs/tags",component:u("/docs/tags","fce"),exact:!0},{path:"/docs/tags/ai",component:u("/docs/tags/ai","bd3"),exact:!0},{path:"/docs/tags/api",component:u("/docs/tags/api","0eb"),exact:!0},{path:"/docs/tags/compose",component:u("/docs/tags/compose","e2c"),exact:!0},{path:"/docs/tags/containers",component:u("/docs/tags/containers","3fc"),exact:!0},{path:"/docs/tags/docker",component:u("/docs/tags/docker","0d0"),exact:!0},{path:"/docs/tags/extension",component:u("/docs/tags/extension","a8f"),exact:!0},{path:"/docs/tags/flathub",component:u("/docs/tags/flathub","d52"),exact:!0},{path:"/docs/tags/flatpak",component:u("/docs/tags/flatpak","dc5"),exact:!0},{path:"/docs/tags/generative-ai",component:u("/docs/tags/generative-ai","172"),exact:!0},{path:"/docs/tags/icons",component:u("/docs/tags/icons","c73"),exact:!0},{path:"/docs/tags/images",component:u("/docs/tags/images","f8c"),exact:!0},{path:"/docs/tags/installing",component:u("/docs/tags/installing","a13"),exact:!0},{path:"/docs/tags/kind",component:u("/docs/tags/kind","dc2"),exact:!0},{path:"/docs/tags/kubernetes",component:u("/docs/tags/kubernetes","a8b"),exact:!0},{path:"/docs/tags/lima",component:u("/docs/tags/lima","c16"),exact:!0},{path:"/docs/tags/linux",component:u("/docs/tags/linux","845"),exact:!0},{path:"/docs/tags/llm",component:u("/docs/tags/llm","cef"),exact:!0},{path:"/docs/tags/mac-0-s",component:u("/docs/tags/mac-0-s","2cf"),exact:!0},{path:"/docs/tags/mac-os",component:u("/docs/tags/mac-os","ada"),exact:!0},{path:"/docs/tags/macos",component:u("/docs/tags/macos","2f4"),exact:!0},{path:"/docs/tags/migrating-from-docker",component:u("/docs/tags/migrating-from-docker","2ce"),exact:!0},{path:"/docs/tags/migrating-to-kubernetes",component:u("/docs/tags/migrating-to-kubernetes","599"),exact:!0},{path:"/docs/tags/minikube",component:u("/docs/tags/minikube","f98"),exact:!0},{path:"/docs/tags/onboarding",component:u("/docs/tags/onboarding","643"),exact:!0},{path:"/docs/tags/openshift",component:u("/docs/tags/openshift","af8"),exact:!0},{path:"/docs/tags/podman",component:u("/docs/tags/podman","0e3"),exact:!0},{path:"/docs/tags/podman-desktop",component:u("/docs/tags/podman-desktop","63e"),exact:!0},{path:"/docs/tags/pods",component:u("/docs/tags/pods","867"),exact:!0},{path:"/docs/tags/publishing",component:u("/docs/tags/publishing","897"),exact:!0},{path:"/docs/tags/when-clause",component:u("/docs/tags/when-clause","9ab"),exact:!0},{path:"/docs/tags/windows",component:u("/docs/tags/windows","439"),exact:!0},{path:"/docs/tags/writing",component:u("/docs/tags/writing","01f"),exact:!0},{path:"/docs",component:u("/docs","2d6"),routes:[{path:"/docs/ai-lab",component:u("/docs/ai-lab","fd2"),exact:!0,sidebar:"mySidebar"},{path:"/docs/ai-lab/create-playground",component:u("/docs/ai-lab/create-playground","7ee"),exact:!0,sidebar:"mySidebar"},{path:"/docs/ai-lab/download-model",component:u("/docs/ai-lab/download-model","8e0"),exact:!0,sidebar:"mySidebar"},{path:"/docs/ai-lab/installing",component:u("/docs/ai-lab/installing","e0a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/ai-lab/start-inference-server",component:u("/docs/ai-lab/start-inference-server","a04"),exact:!0,sidebar:"mySidebar"},{path:"/docs/ai-lab/start-recipe",component:u("/docs/ai-lab/start-recipe","95d"),exact:!0,sidebar:"mySidebar"},{path:"/docs/compose",component:u("/docs/compose","658"),exact:!0,sidebar:"mySidebar"},{path:"/docs/compose/running-compose",component:u("/docs/compose/running-compose","b7e"),exact:!0,sidebar:"mySidebar"},{path:"/docs/compose/setting-up-compose",component:u("/docs/compose/setting-up-compose","292"),exact:!0,sidebar:"mySidebar"},{path:"/docs/compose/troubleshooting",component:u("/docs/compose/troubleshooting","3a0"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers",component:u("/docs/containers","97b"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/creating-a-pod",component:u("/docs/containers/creating-a-pod","6bc"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/images",component:u("/docs/containers/images","022"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/images/building-an-image",component:u("/docs/containers/images/building-an-image","269"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/images/pulling-an-image",component:u("/docs/containers/images/pulling-an-image","057"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/images/pushing-an-image-to-a-registry",component:u("/docs/containers/images/pushing-an-image-to-a-registry","301"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/onboarding",component:u("/docs/containers/onboarding","10f"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/registries",component:u("/docs/containers/registries","220"),exact:!0,sidebar:"mySidebar"},{path:"/docs/containers/starting-a-container",component:u("/docs/containers/starting-a-container","bf6"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions",component:u("/docs/extensions","52e"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/api",component:u("/docs/extensions/api","355"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing",component:u("/docs/extensions/developing","e91"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/adding-icons",component:u("/docs/extensions/developing/adding-icons","c69"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/command-palette",component:u("/docs/extensions/developing/command-palette","01e"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/commands",component:u("/docs/extensions/developing/commands","fba"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/config",component:u("/docs/extensions/developing/config","b40"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/menu",component:u("/docs/extensions/developing/menu","9b6"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/onboarding-workflow",component:u("/docs/extensions/developing/onboarding-workflow","233"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/developing/when-clause-context",component:u("/docs/extensions/developing/when-clause-context","8c5"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/install",component:u("/docs/extensions/install","bd4"),exact:!0,sidebar:"mySidebar"},{path:"/docs/extensions/publish",component:u("/docs/extensions/publish","abf"),exact:!0,sidebar:"mySidebar"},{path:"/docs/installation",component:u("/docs/installation","c99"),exact:!0,sidebar:"mySidebar"},{path:"/docs/installation/linux-install",component:u("/docs/installation/linux-install","f25"),exact:!0,sidebar:"mySidebar"},{path:"/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle",component:u("/docs/installation/linux-install/installing-podman-desktop-from-a-flatpak-bundle","d72"),exact:!0,sidebar:"mySidebar"},{path:"/docs/installation/macos-install",component:u("/docs/installation/macos-install","191"),exact:!0,sidebar:"mySidebar"},{path:"/docs/installation/windows-install",component:u("/docs/installation/windows-install","740"),exact:!0,sidebar:"mySidebar"},{path:"/docs/intro",component:u("/docs/intro","193"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind",component:u("/docs/kind","ca0"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/building-an-image-and-testing-it-in-kind",component:u("/docs/kind/building-an-image-and-testing-it-in-kind","814"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/configuring-podman-for-kind-on-windows",component:u("/docs/kind/configuring-podman-for-kind-on-windows","457"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/creating-a-kind-cluster",component:u("/docs/kind/creating-a-kind-cluster","fda"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/deleting-your-kind-cluster",component:u("/docs/kind/deleting-your-kind-cluster","b33"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/installing",component:u("/docs/kind/installing","772"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/pushing-an-image-to-kind",component:u("/docs/kind/pushing-an-image-to-kind","6ba"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/restarting-your-kind-cluster",component:u("/docs/kind/restarting-your-kind-cluster","39b"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kind/working-with-your-local-kind-cluster",component:u("/docs/kind/working-with-your-local-kind-cluster","a67"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes",component:u("/docs/kubernetes","70c"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/deploying-a-container-to-kubernetes",component:u("/docs/kubernetes/deploying-a-container-to-kubernetes","980"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/deploying-a-pod-to-kubernetes",component:u("/docs/kubernetes/deploying-a-pod-to-kubernetes","61b"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/existing-kubernetes",component:u("/docs/kubernetes/existing-kubernetes","a9c"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/kind/pushing-an-image-to-kind",component:u("/docs/kubernetes/kind/pushing-an-image-to-kind","257"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/lima/pushing-an-image-to-lima",component:u("/docs/kubernetes/lima/pushing-an-image-to-lima","0b8"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/minikube/pushing-an-image-to-minikube",component:u("/docs/kubernetes/minikube/pushing-an-image-to-minikube","933"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/viewing-and-selecting-current-kubernete-context",component:u("/docs/kubernetes/viewing-and-selecting-current-kubernete-context","275"),exact:!0,sidebar:"mySidebar"},{path:"/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar",component:u("/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar","b03"),exact:!0,sidebar:"mySidebar"},{path:"/docs/lima",component:u("/docs/lima","3fb"),exact:!0,sidebar:"mySidebar"},{path:"/docs/lima/creating-a-kubernetes-instance",component:u("/docs/lima/creating-a-kubernetes-instance","af8"),exact:!0,sidebar:"mySidebar"},{path:"/docs/lima/creating-a-lima-instance",component:u("/docs/lima/creating-a-lima-instance","852"),exact:!0,sidebar:"mySidebar"},{path:"/docs/lima/customizing",component:u("/docs/lima/customizing","82f"),exact:!0,sidebar:"mySidebar"},{path:"/docs/lima/installing",component:u("/docs/lima/installing","e13"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker",component:u("/docs/migrating-from-docker","28a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker/emulating-docker-cli-with-podman",component:u("/docs/migrating-from-docker/emulating-docker-cli-with-podman","a64"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker/importing-saved-containers",component:u("/docs/migrating-from-docker/importing-saved-containers","fa8"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker/using-podman-mac-helper",component:u("/docs/migrating-from-docker/using-podman-mac-helper","d42"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker/using-the-docker_host-environment-variable",component:u("/docs/migrating-from-docker/using-the-docker_host-environment-variable","79a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/migrating-from-docker/verifying-your-tools-are-using-podman",component:u("/docs/migrating-from-docker/verifying-your-tools-are-using-podman","6d4"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube",component:u("/docs/minikube","c4a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/building-an-image-and-testing-it-in-minikube",component:u("/docs/minikube/building-an-image-and-testing-it-in-minikube","410"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/configuring-podman-for-minikube-on-windows",component:u("/docs/minikube/configuring-podman-for-minikube-on-windows","31c"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/creating-a-minikube-cluster",component:u("/docs/minikube/creating-a-minikube-cluster","44c"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/deleting-your-minikube-cluster",component:u("/docs/minikube/deleting-your-minikube-cluster","3bd"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/installing",component:u("/docs/minikube/installing","d2c"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/pushing-an-image-to-minikube",component:u("/docs/minikube/pushing-an-image-to-minikube","c1a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/restarting-your-minikube-cluster",component:u("/docs/minikube/restarting-your-minikube-cluster","5c6"),exact:!0,sidebar:"mySidebar"},{path:"/docs/minikube/working-with-your-local-minikube-cluster",component:u("/docs/minikube/working-with-your-local-minikube-cluster","a37"),exact:!0,sidebar:"mySidebar"},{path:"/docs/openshift",component:u("/docs/openshift","c81"),exact:!0,sidebar:"mySidebar"},{path:"/docs/openshift/developer-sandbox",component:u("/docs/openshift/developer-sandbox","0bf"),exact:!0,sidebar:"mySidebar"},{path:"/docs/openshift/openshift-local",component:u("/docs/openshift/openshift-local","54b"),exact:!0,sidebar:"mySidebar"},{path:"/docs/podman",component:u("/docs/podman","86d"),exact:!0,sidebar:"mySidebar"},{path:"/docs/podman/accessing-podman-from-another-wsl-instance",component:u("/docs/podman/accessing-podman-from-another-wsl-instance","ddc"),exact:!0,sidebar:"mySidebar"},{path:"/docs/podman/creating-a-podman-machine",component:u("/docs/podman/creating-a-podman-machine","8cc"),exact:!0,sidebar:"mySidebar"},{path:"/docs/podman/setting-podman-machine-default-connection",component:u("/docs/podman/setting-podman-machine-default-connection","407"),exact:!0,sidebar:"mySidebar"},{path:"/docs/proxy",component:u("/docs/proxy","900"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting",component:u("/docs/troubleshooting","afe"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting/troubleshooting-openshift-local",component:u("/docs/troubleshooting/troubleshooting-openshift-local","500"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting/troubleshooting-podman",component:u("/docs/troubleshooting/troubleshooting-podman","fe9"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting/troubleshooting-podman-on-linux",component:u("/docs/troubleshooting/troubleshooting-podman-on-linux","f6a"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting/troubleshooting-podman-on-macos",component:u("/docs/troubleshooting/troubleshooting-podman-on-macos","775"),exact:!0,sidebar:"mySidebar"},{path:"/docs/troubleshooting/troubleshooting-podman-on-windows",component:u("/docs/troubleshooting/troubleshooting-podman-on-windows","d01"),exact:!0,sidebar:"mySidebar"}]}]}]},{path:"/",component:u("/","e5f"),exact:!0},{path:"*",component:u("*")}]},56285:(e,t,n)=>{"use strict";n.d(t,{lX:()=>x,q_:()=>T,ob:()=>b,PP:()=>A,Ep:()=>m});var a=n(52685);function i(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,a=n+1,i=e.length;a=0;p--){var f=r[p];"."===f?o(r,p):".."===f?(o(r,p),u++):u&&(o(r,p),u--)}if(!l)for(;u--;u)r.unshift("..");!l||""===r[0]||r[0]&&i(r[0])||r.unshift("");var m=r.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var s=!0,c="Invariant failed";function l(e,t){if(!e){if(s)throw new Error(c);var n="function"==typeof t?t():t;throw new Error(n?c+": "+n:c)}}function d(e){return"/"===e.charAt(0)?e:"/"+e}function u(e){return"/"===e.charAt(0)?e.substr(1):e}function p(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function f(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function m(e){var t=e.pathname,n=e.search,a=e.hash,i=t||"/";return n&&"?"!==n&&(i+="?"===n.charAt(0)?n:"?"+n),a&&"#"!==a&&(i+="#"===a.charAt(0)?a:"#"+a),i}function b(e,t,n,i){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",a="",i=t.indexOf("#");-1!==i&&(a=t.substr(i),t=t.substr(0,i));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===a?"":a}}(e),o.state=t):(void 0===(o=(0,a.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(o.key=n),i?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=r(o.pathname,i.pathname)):o.pathname=i.pathname:o.pathname||(o.pathname="/"),o}function g(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,a,i){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof a?a(o,i):i(!0):i(!1!==o)}else i(!0)},appendListener:function(e){var n=!0;function a(){n&&e.apply(void 0,arguments)}return t.push(a),function(){n=!1,t=t.filter((function(e){return e!==a}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),a=0;at?n.splice(t,n.length-t,i):n.push(i),u({action:a,location:i,index:t,entries:n})}}))},replace:function(e,t){var a="REPLACE",i=b(e,t,p(),k.location);d.confirmTransitionTo(i,a,n,(function(e){e&&(k.entries[k.index]=i,u({action:a,location:i}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=k.index+e;return t>=0&&t{"use strict";var a=n(19185),i={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},r={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function c(e){return a.isMemo(e)?r:s[e.$$typeof]||i}s[a.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[a.Memo]=r;var l=Object.defineProperty,d=Object.getOwnPropertyNames,u=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,a){if("string"!=typeof n){if(m){var i=f(n);i&&i!==m&&e(t,i,a)}var r=d(n);u&&(r=r.concat(u(n)));for(var s=c(t),b=c(n),g=0;g{"use strict";e.exports=function(e,t,n,a,i,o,r,s){if(!e){var c;if(void 0===t)c=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var l=[n,a,i,o,r,s],d=0;(c=new Error(t.replace(/%s/g,(function(){return l[d++]})))).name="Invariant Violation"}throw c.framesToPop=1,c}}},70142:(e,t,n)=>{"use strict";n.r(t)},26222:(e,t,n)=>{"use strict";n.r(t)},8504:function(e,t,n){var a,i;a=function(){var e,t,n={version:"0.2.0"},a=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function i(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function r(e,t,n){var i;return(i="translate3d"===a.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===a.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,i}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(a[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=i(e,a.minimum,1),n.status=1===e?null:e;var o=n.render(!t),l=o.querySelector(a.barSelector),d=a.speed,u=a.easing;return o.offsetWidth,s((function(t){""===a.positionUsing&&(a.positionUsing=n.getPositioningCSS()),c(l,r(e,d,u)),1===e?(c(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){c(o,{transition:"all "+d+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),d)}),d)):setTimeout(t,d)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),a.trickleSpeed)};return a.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*i(Math.random()*t,.1,.95)),t=i(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*a.trickleRate)},e=0,t=0,n.promise=function(a){return a&&"resolved"!==a.state()?(0===t&&n.start(),e++,t++,a.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");d(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=a.template;var i,r=t.querySelector(a.barSelector),s=e?"-100":o(n.status||0),l=document.querySelector(a.parent);return c(r,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),a.showSpinner||(i=t.querySelector(a.spinnerSelector))&&f(i),l!=document.body&&d(l,"nprogress-custom-parent"),l.appendChild(t),t},n.remove=function(){u(document.documentElement,"nprogress-busy"),u(document.querySelector(a.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function a(t){var n=document.body.style;if(t in n)return t;for(var a,i=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);i--;)if((a=e[i]+o)in n)return a;return t}function i(e){return e=n(e),t[e]||(t[e]=a(e))}function o(e,t,n){t=i(t),e.style[t]=n}return function(e,t){var n,a,i=arguments;if(2==i.length)for(n in t)void 0!==(a=t[n])&&t.hasOwnProperty(n)&&o(e,n,a);else o(e,i[1],i[2])}}();function l(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function d(e,t){var n=p(e),a=n+t;l(n,t)||(e.className=a.substring(1))}function u(e,t){var n,a=p(e);l(e,t)&&(n=a.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(i="function"==typeof a?a.call(t,n,t,e):a)||(e.exports=i)},10247:()=>{!function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},a={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?:\.\w+)*(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},parameter:{pattern:/(^|\s)-{1,2}(?:\w+:[+-]?)?\w+(?:\.\w+)*(?=[=\s]|$)/,alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:a},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:a},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:a.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:a.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cargo|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|java|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|sysctl|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var i=["comment","function-name","for-or-select","assign-left","parameter","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=a.variable[1].inside,r=0;r{!function(e){var t=/\\[\r\n](?:\s|\\[\r\n]|#.*(?!.))*(?![\s#]|\\[\r\n])/.source,n=/(?:[ \t]+(?![ \t])(?:)?|)/.source.replace(//g,(function(){return t})),a=/"(?:[^"\\\r\n]|\\(?:\r\n|[\s\S]))*"|'(?:[^'\\\r\n]|\\(?:\r\n|[\s\S]))*'/.source,i=/--[\w-]+=(?:|(?!["'])(?:[^\s\\]|\\.)+)/.source.replace(//g,(function(){return a})),o={pattern:RegExp(a),greedy:!0},r={pattern:/(^[ \t]*)#.*/m,lookbehind:!0,greedy:!0};function s(e,t){return e=e.replace(//g,(function(){return i})).replace(//g,(function(){return n})),RegExp(e,t)}e.languages.docker={instruction:{pattern:/(^[ \t]*)(?:ADD|ARG|CMD|COPY|ENTRYPOINT|ENV|EXPOSE|FROM|HEALTHCHECK|LABEL|MAINTAINER|ONBUILD|RUN|SHELL|STOPSIGNAL|USER|VOLUME|WORKDIR)(?=\s)(?:\\.|[^\r\n\\])*(?:\\$(?:\s|#.*$)*(?![\s#])(?:\\.|[^\r\n\\])*)*/im,lookbehind:!0,greedy:!0,inside:{options:{pattern:s(/(^(?:ONBUILD)?\w+)(?:)*/.source,"i"),lookbehind:!0,greedy:!0,inside:{property:{pattern:/(^|\s)--[\w-]+/,lookbehind:!0},string:[o,{pattern:/(=)(?!["'])(?:[^\s\\]|\\.)+/,lookbehind:!0}],operator:/\\$/m,punctuation:/=/}},keyword:[{pattern:s(/(^(?:ONBUILD)?HEALTHCHECK(?:)*)(?:CMD|NONE)\b/.source,"i"),lookbehind:!0,greedy:!0},{pattern:s(/(^(?:ONBUILD)?FROM(?:)*(?!--)[^ \t\\]+)AS/.source,"i"),lookbehind:!0,greedy:!0},{pattern:s(/(^ONBUILD)\w+/.source,"i"),lookbehind:!0,greedy:!0},{pattern:/^\w+/,greedy:!0}],comment:r,string:o,variable:/\$(?:\w+|\{[^{}"'\\]*\})/,operator:/\\$/m}},comment:r},e.languages.dockerfile=e.languages.docker}(Prism)},5094:()=>{Prism.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},Prism.languages.webmanifest=Prism.languages.json},13109:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,a,i,o){if(n.language===a){var r=n.tokenStack=[];n.code=n.code.replace(i,(function(e){if("function"==typeof o&&!o(e))return e;for(var i,s=r.length;-1!==n.code.indexOf(i=t(a,s));)++s;return r[s]=e,i})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,a){if(n.language===a&&n.tokenStack){n.grammar=e.languages[a];var i=0,o=Object.keys(n.tokenStack);!function r(s){for(var c=0;c=o.length);c++){var l=s[c];if("string"==typeof l||l.content&&"string"==typeof l.content){var d=o[i],u=n.tokenStack[d],p="string"==typeof l?l:l.content,f=t(a,d),m=p.indexOf(f);if(m>-1){++i;var b=p.substring(0,m),g=new e.Token(a,e.tokenize(u,n.grammar),"language-"+a,u),h=p.substring(m+f.length),y=[];b&&y.push.apply(y,r([b])),y.push(g),h&&y.push.apply(y,r([h])),"string"==typeof l?s.splice.apply(s,[c,1].concat(y)):l.content=y}}else l.content&&r(l.content)}return s}(n.tokens)}}}})}(Prism)},3069:()=>{!function(e){var t=[/"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/.source,/'[^']*'/.source,/\$'(?:[^'\\]|\\[\s\S])*'/.source,/<<-?\s*(["']?)(\w+)\1\s[\s\S]*?[\r\n]\2/.source].join("|");e.languages["shell-session"]={command:{pattern:RegExp(/^/.source+"(?:"+/[^\s@:$#%*!/\\]+@[^\r\n@:$#%*!/\\]+(?::[^\0-\x1F$#%*?"<>:;|]+)?/.source+"|"+/[/~.][^\0-\x1F$#%*?"<>@:;|]*/.source+")?"+/[$#%](?=\s)/.source+/(?:[^\\\r\n \t'"<$]|[ \t](?:(?!#)|#.*$)|\\(?:[^\r]|\r\n?)|\$(?!')|<(?!<)|<>)+/.source.replace(/<>/g,(function(){return t})),"m"),greedy:!0,inside:{info:{pattern:/^[^#$%]+/,alias:"punctuation",inside:{user:/^[^\s@:$#%*!/\\]+@[^\r\n@:$#%*!/\\]+/,punctuation:/:/,path:/[\s\S]+/}},bash:{pattern:/(^[$#%]\s*)\S[\s\S]*/,lookbehind:!0,alias:"language-bash",inside:e.languages.bash},"shell-symbol":{pattern:/^[$#%]/,alias:"important"}}},output:/.(?:.*(?:[\r\n]|.$))*/},e.languages["sh-session"]=e.languages.shellsession=e.languages["shell-session"]}(Prism)},60926:(e,t,n)=>{var a={"./prism-bash":10247,"./prism-docker":36761,"./prism-json":5094,"./prism-shell-session":3069};function i(e){var t=o(e);return n(t)}function o(e){if(!n.o(a,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return a[e]}i.keys=function(){return Object.keys(a)},i.resolve=o,e.exports=i,i.id=60926},58772:(e,t,n)=>{"use strict";var a=n(90331);function i(){}function o(){}o.resetWarningCache=i,e.exports=function(){function e(e,t,n,i,o,r){if(r!==a){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:i};return n.PropTypes=n,n}},23615:(e,t,n)=>{e.exports=n(58772)()},90331:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},43577:(e,t,n)=>{"use strict";var a=n(27378),i=n(91102);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n